updated docs
This commit is contained in:
66
README.md
66
README.md
@@ -1,51 +1,45 @@
|
||||
# Soleprint
|
||||
# soleprint
|
||||
|
||||
Development workflow platform. Run, test, and document everything in one place.
|
||||
Development workflow platform. Wraps existing applications with tools, testing, and documentation — without touching source code.
|
||||
|
||||
Cada paso deja huella.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Build and run standalone
|
||||
python build.py
|
||||
cd gen/standalone && docker compose up
|
||||
# Visit http://localhost:12000
|
||||
# Create a room
|
||||
python -m init.cli myroom
|
||||
|
||||
# Build and run with room config
|
||||
python build.py --cfg <room>
|
||||
cd gen/<room>/soleprint && docker compose up
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
# Build
|
||||
python build.py # -> gen/standalone/
|
||||
python build.py --cfg <room> # -> gen/<room>/
|
||||
python build.py --all # -> all rooms
|
||||
python build.py --cfg myroom
|
||||
|
||||
# Using ctrl scripts
|
||||
./ctrl/build.sh # Build standalone
|
||||
./ctrl/build.sh <room> # Build room
|
||||
./ctrl/start.sh # Start standalone
|
||||
./ctrl/start.sh <room> # Start room
|
||||
./ctrl/stop.sh <room> # Stop
|
||||
./ctrl/logs.sh <room> # View logs
|
||||
# Run
|
||||
cd gen/myroom/soleprint && docker compose up
|
||||
|
||||
# Bare-metal dev (without Docker)
|
||||
cd gen/standalone && python run.py
|
||||
# Visit http://localhost:12000
|
||||
```
|
||||
|
||||
## Adding a New Room
|
||||
Or use the browser wizard: `python -m init.web` → http://localhost:9000
|
||||
|
||||
## Docs
|
||||
|
||||
```bash
|
||||
# 1. Create room config
|
||||
mkdir -p cfg/myroom/data
|
||||
cp cfg/standalone/config.json cfg/myroom/
|
||||
cp -r cfg/standalone/data/* cfg/myroom/data/
|
||||
|
||||
# 2. Build and run
|
||||
python build.py --cfg myroom
|
||||
cd gen/myroom/soleprint && docker compose up
|
||||
cd docs && python -m http.server 8080
|
||||
# http://localhost:8080
|
||||
```
|
||||
|
||||
Or use the generation UI: `python -m http.server 8080` in `spr/` and visit `/generate.html`.
|
||||
## 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)
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user