Skip to content

Commit 8fb3190

Browse files
eddmannclaude
andcommitted
Add santa-site tool documentation to README
- Update tooling section to include santa-site with command examples - Add santa-site to repository layout tools list - Change tool count from three to four tools in overview 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 8518006 commit 8fb3190

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This project provides a means to scaffold, build, and verify `elf-lang` implemen
3131
- `specs/TASKS.md`: agent workflow, CLI contract, stage scopes, and completion criteria
3232
- `tests/`: stage directories containing `.santat` PHPT-style conformance tests and a short stage `README.md` describing scope and rules
3333
- `examples/`: example `.santa` programs
34-
- `tools/`: Rust binaries `santa-test`, `santa-bootstrap`, and `santa-journal`
34+
- `tools/`: Rust binaries `santa-test`, `santa-bootstrap`, `santa-journal`, and `santa-site`
3535
- `impl/`: per-implementation directories generated by `santa-bootstrap`
3636

3737
### Development stages (high level)
@@ -84,7 +84,7 @@ Advancement rule: only proceed when all tests in the current stage and all prior
8484

8585
### Tooling
8686

87-
The workshop includes three helper tools: `santa-bootstrap` (scaffold a new implementation), `santa-test` (run PHPT‑style tests), and `santa-journal` (track progress and decisions). The generated implementation directory contains your code, an executable `cli`, any language‑specific files, and a `JOURNAL` for continuity.
87+
The workshop includes four helper tools: `santa-bootstrap` (scaffold a new implementation), `santa-test` (run PHPT‑style tests), `santa-journal` (track progress and decisions), and `santa-site` (generate a static website showcasing implementations). The generated implementation directory contains your code, an executable `cli`, any language‑specific files, and a `JOURNAL` for continuity.
8888

8989
- santa-bootstrap
9090

@@ -107,6 +107,14 @@ tools/bin/santa-journal [--dir <impl-dir>] <author|progress|entry|entries> [...]
107107
tools/bin/santa-journal progress stage-2 set in-progress
108108
```
109109

110+
- santa-site
111+
112+
```bash
113+
tools/bin/santa-site [--out-dir <path>] [--impl-dir <path>] [--base-path <url-path>]
114+
# example
115+
tools/bin/santa-site --out-dir docs --base-path /santa-lang-workshop
116+
```
117+
110118
### Running examples (after completion)
111119

112120
Implementations that pass all stages should be able to run the examples from repo root using the Makefile:

0 commit comments

Comments
 (0)