diff --git a/README.md b/README.md index 11580bc..4658150 100644 --- a/README.md +++ b/README.md @@ -2,44 +2,14 @@ Development workflow platform. Wraps existing applications with tools, testing, and documentation — without touching source code. -Cada paso deja huella. +*Cada paso deja huella.* -## Quick Start - -```bash -# Create a room -python -m init.cli myroom - -# Build -python build.py --cfg myroom - -# Run -cd gen/myroom/soleprint && docker compose up - -# Visit http://localhost:12000 -``` - -Or use the browser wizard: `python -m init.web` → http://localhost:9000 +--- ## Docs ```bash cd docs && python -m http.server 8080 -# http://localhost:8080 ``` -## Structure - -``` -spr/ -├── soleprint/ # Core framework -│ ├── artery/ # Connectors (veins, shunts, pulses) -│ ├── atlas/ # Documentation (books, templates) -│ └── station/ # Tools (tester, datagen, modelgen) -├── cfg/ # Room configurations -├── init/ # Room setup (CLI + web wizard) -├── docs/ # Documentation site -├── ctrl/ # Build/deploy scripts -├── build.py # Build tool: cfg/ → gen/ -└── gen/ # Built instances (gitignored) -``` +Visit `http://localhost:8080`. Start with [Concepts](docs/data/en/concepts.md) for the mental model, then [Quickstart](docs/data/en/quickstart.md) to run your first room. diff --git a/docs/data/en/atlas.md b/docs/data/en/atlas.md index 88704c1..0bdf107 100644 --- a/docs/data/en/atlas.md +++ b/docs/data/en/atlas.md @@ -31,10 +31,10 @@ Core books live in `soleprint/atlas/books/`. Room-specific books live in `cfg//atlas/books/ # Room-specific books ↓ build.py -gen/amar/soleprint/atlas/books/ # Merged output +gen//soleprint/atlas/books/ # Merged output ``` Core books ship with every room. Room books add to or override them. The build copies the core first, then overlays the room-specific content. diff --git a/docs/data/en/concepts.md b/docs/data/en/concepts.md index 7536ba1..59c3a0f 100644 --- a/docs/data/en/concepts.md +++ b/docs/data/en/concepts.md @@ -11,7 +11,6 @@ A room is an isolated configuration. Each room lives in `cfg//` and contai ``` cfg/ standalone/ # Soleprint only, no managed app - amar/ # Soleprint wrapping the Amar application myroom/ # Your room ``` diff --git a/docs/data/en/station-datagen.md b/docs/data/en/station-datagen.md index 4ec5bdc..08ea501 100644 --- a/docs/data/en/station-datagen.md +++ b/docs/data/en/station-datagen.md @@ -28,7 +28,7 @@ Rooms subclass a base generator and provide domain-specific data factories: ```python from station.tools.datagen.base import BaseGenerator -class AmarDataGenerator(BaseGenerator): +class RoomDataGenerator(BaseGenerator): def generate_customers(self, count=10): return [self.fake_customer() for _ in range(count)]