Files
ARCADIA-Studio/scripts/package-cli-readme.md

39 lines
2.0 KiB
Markdown

# Arcadia CLI portable Windows bundle
Extract the whole archive into a writable directory. Open a terminal there:
```powershell
.\arcadia.exe --version
.\arcadia.exe --help
.\arcadia.exe check examples/text-first/project.arcadia
```
Keep `libunwind.dll` beside `arcadia.exe` when included. The x86-64 gnullvm bundle
uses the Windows Universal C Runtime. No compiler installation, desktop editor,
network service or machine PATH change is needed to use this executable.
Read the [CLI command and diagnostic contract](docs/source-cli.md), the
[text-first examples](examples/text-first/README.md) and the
[language reference](docs/language.html) ([text source](docs/language.rst)).
Copy a complete example folder into your own work directory before editing it.
Supply the project entry file explicitly. Editing commands preview by default;
`--write` saves the candidate prepared by that invocation. A later invocation
may choose different provisional UUIDs for records whose IDs are still missing.
Some example walkthroughs describe Studio controls such as Apply and Save.
For this CLI, edit the copied text in your editor, run `arcadia check` on its
entry, review `arcadia stabilize project.arcadia`, then use
`arcadia stabilize project.arcadia --write` to save
missing identities. The full `examples/release1` model and evidence are included
for studying modular source; running its visual walkthrough requires Studio.
The build instructions in the CLI documentation refer to a separate source
checkout; this archive contains the executable and examples. It does not include
repository sources needed for Cargo commands. The published milestone's source
and exact build evidence are identified in its release record and `package.json`.
`SHA256SUMS.txt` records the package files. `THIRD-PARTY-NOTICES.txt`,
`dependency-notices.json` and `licenses/` retain exact dependency, embedded-asset,
Rust and runtime notices. Packaging integrity does not establish runtime
acceptance; read the distributor's binary-specific acceptance record.