command and help ux pass (#21)
Reviewed-on: #21 Co-authored-by: vickydotbat <vickydotbat@tutamail.com> Co-committed-by: vickydotbat <vickydotbat@tutamail.com>
This commit was merged in pull request #21.
This commit is contained in:
@@ -29,7 +29,7 @@ command lands is mapped in [`docs/command-surface.md`](docs/command-surface.md).
|
||||
|
||||
## Status (cutover performed)
|
||||
|
||||
The internal `app`/`pipeline`/`project`/`erf`/`gff`/`topdata`/`music`/`changelog`/
|
||||
The internal `app`/`pipeline`/`project`/`erf`/`gff`/`topdata`/`changelog`/
|
||||
`validator` packages from `gitea/sow-tools` have been migrated into this tree, and
|
||||
the `module`, `topdata`, `hak`, and `wiki` builders now **delegate to the migrated
|
||||
`nwn-tool` command surface** (mapped in
|
||||
@@ -49,7 +49,7 @@ which downloads the latest released `crucible` for your OS and runs it:
|
||||
```bash
|
||||
./crucible # interactive menu (pick a command)
|
||||
./crucible module build
|
||||
./crucible topdata validate-topdata
|
||||
./crucible topdata validate
|
||||
```
|
||||
|
||||
Windows (PowerShell):
|
||||
@@ -62,15 +62,12 @@ The binary is cached under `~/.cache/crucible/<version>/` (`%LOCALAPPDATA%\cruci
|
||||
on Windows); `--repo-local` caches inside the repo instead. Private releases:
|
||||
set `CRUCIBLE_TOKEN` or write the token to `~/.config/crucible/token`.
|
||||
|
||||
Only the **music** builder needs `ffmpeg`; everything else has zero dependencies.
|
||||
If you run a music command without it, Crucible prints a per-OS install hint.
|
||||
|
||||
## Develop
|
||||
|
||||
Self-contained (D8) — a host with only Nix can run everything:
|
||||
|
||||
```bash
|
||||
nix develop # Go + ffmpeg + shellcheck + yamllint + make
|
||||
nix develop # Go + shellcheck + yamllint + make
|
||||
make check # go vet + go test + shellcheck + yamllint
|
||||
make build # build every cmd/* into ./bin (gitignored)
|
||||
make smoke # build + assert the fail-closed contract
|
||||
|
||||
Reference in New Issue
Block a user