Skip to content

English · Español

Guía de inicio

Una visita guiada de una página para tus primeros 30 minutos en el repositorio. Asume que tienes git, Python 3.11.x (usa pyenv o mise) y una shell reciente.

1. Instala el toolchain (5 min)

Clona:

git clone https://github.com/borjatarraso/lynx-cortex.git
cd lynx-cortex

Instala uv (gestor de entorno + lockfile para Python) y just (task runner). Elige la fila para tu sistema operativo — just y uv son las dos únicas instalaciones necesarias; todo lo demás lo proveerá just setup.

Sistema operativo uv just
Fedora 43+ (el objetivo canónico — CLAUDE.md §6) sudo dnf install uv o curl -LsSf https://astral.sh/uv/install.sh \| sh sudo dnf install just
Fedora ≤ 42 curl -LsSf https://astral.sh/uv/install.sh \| sh sudo dnf install just (en los repos desde F38)
Debian / Ubuntu curl -LsSf https://astral.sh/uv/install.sh \| sh sudo apt install just (Debian 13+ / Ubuntu 24.04+) o prebuilt-mpr para releases anteriores
Arch / Manjaro sudo pacman -S uv sudo pacman -S just
macOS brew install uv brew install just
Cualquier otro (último recurso) curl -LsSf https://astral.sh/uv/install.sh \| sh cargo install just (requiere un toolchain de Rust completo — evítalo en Fedora, el paquete de la distro es un solo comando)

Verifica:

uv --version    # ≥ 0.4.18
just --version

🇪🇸 uv reemplaza a pip/venv/virtualenv con una sola herramienta. just es el make moderno: cada ritual del repositorio vive en el Justfile.

2. Aprovisiona el entorno (5 min)

just setup        # uv sync con extras de Fase 0 + pre-commit + hook pre-push
just lint         # ruff + ruff format --check + mypy en src/
just test         # pytest con la autouse seed fixture

Si just lint o just test fallan en un clon fresco, eso es un bug — por favor abre un issue.

3. Navega el currículo (5 min)

just docs-serve   # http://127.0.0.1:8000

El sitio que estás leyendo es la documentación renderizada. El mismo contenido es markdown plano bajo docs/, así que leerlo sin el sitio también está bien.

4. Lee el contrato (10 min)

En orden:

  1. LYNX_CORTEX.md §0 (contrato pedagógico) y §7 (ritual por fase).
  2. LYNX_CORTEX_ADDENDUM.md §A13 (el alcance microscópico) y §A17 (política bilingüe).
  3. CLAUDE.md (acuerdos de trabajo con Claude Code).

5. Recorre la Fase 00 (5 min)

Cuando el lab termina, la fase queda gateada por PHASE_00_REPORT.md. Ninguna fase comienza antes de que el informe previo sea aprobado.

Qué hay a continuación

  • Learner activo: ver learners/borja/profile.md.
  • ¿Quieres llevar tu propio progreso? Copia learners/_template/ a learners/<tunombre>/ y empieza un journal diario bajo learners/<tunombre>/journal/.

Convenciones (chuleta)

Tema Convención
Python 3.11.x, fijado por .python-version
Gestor de entorno uv (lockfile es uv.lock); nunca pip install fuera de uv
Lint / format ruff
Type check mypy --strict sobre src/
Tests pytest; autouse seed fixture en tests/conftest.py
Notebooks despojados por nbstripout, linted vía nbqa
Seguridad bandit sobre src/, pip-audit sobre el lockfile
Mensajes de commit Solo en inglés

Eso es todo. Abre la Fase 00 y empieza.