Skip to content

docs: distribution policy — git-clone now, veralang later (#737) #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chethanuk wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −1
Open

docs: distribution policy — git-clone now, veralang later (#737) #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,11 @@ pip install -e .
vera run examples/hello_world.vera
```

Install from the clone as shown — there is no *supported* `pip install vera`.
That name on PyPI is an *unrelated* package (an ERAV citizen-science library),
not this compiler. The planned future PyPI name is `veralang`, gated on the
automated release workflow ([#481](https://github.com/aallan/vera/issues/481)).

For agents, point your model at [SKILL.md](https://raw.githubusercontent.com/aallan/vera/main/SKILL.md). It's the complete language reference, designed to be dropped into a context window. For driving the command-line toolchain itself — checking, verifying, testing, running, and debugging Vera, plus the `builtins`/`effects`/`errors` introspection commands — see the CLI cookbook, [TOOLCHAIN.md](TOOLCHAIN.md).


Expand Down
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,13 @@ pip install -e ".[dev]"

`[dev]` includes everything (tests, linters, the language server). For a lighter install that only adds editor/agent support to the base toolchain, use `pip install -e ".[lsp]"` — see [LSP_SERVER.md](LSP_SERVER.md).

> **Distribution policy.** Installing from a git clone, as above, is the
> supported path — there is no *supported* `pip install vera`. That name on
> PyPI is an *unrelated* package (an ERAV citizen-science library), so
> `pip install vera` fetches different software, not this compiler. The planned
> future PyPI name is `veralang`, gated on the automated release workflow
> ([#481](https://github.com/aallan/vera/issues/481)).


#### Supported platforms

Expand Down
1 change: 0 additions & 1 deletion ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ Exit criterion: each listed drift class has a generator or a gate, and a release
| [#528](https://github.com/aallan/vera/issues/528) | Gate the hand-edited numbers on the veralang.dev homepage against live counts (the Stage 18 landing-page audit found this class live). |
| [#540](https://github.com/aallan/vera/issues/540) | lychee + markdownlint MD051 cross-doc anchor validation. |
| [#481](https://github.com/aallan/vera/issues/481) | Auto-tag and auto-release on version bump — removes the forgettable manual release steps documented in [CONTRIBUTING.md](CONTRIBUTING.md). |
| [#737](https://github.com/aallan/vera/issues/737) | Document the distribution policy (git-clone now; PyPI `veralang` publication gated on #481). |

## Stage 21 — The effect hardening sprint

Expand Down
5 changes: 5 additions & 0 deletions docs/llms-full.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3095,6 +3095,11 @@ pip install -e .
vera run examples/hello_world.vera
```

Install from the clone as shown — there is no *supported* `pip install vera`.
That name on PyPI is an *unrelated* package (an ERAV citizen-science library),
not this compiler. The planned future PyPI name is `veralang`, gated on the
automated release workflow ([#481](https://github.com/aallan/vera/issues/481)).

For agents, point your model at [SKILL.md](https://raw.githubusercontent.com/aallan/vera/main/SKILL.md). It's the complete language reference, designed to be dropped into a context window. For driving the command-line toolchain itself — checking, verifying, testing, running, and debugging Vera, plus the `builtins`/`effects`/`errors` introspection commands — see the CLI cookbook, [TOOLCHAIN.md](https://github.com/aallan/vera/blob/main/TOOLCHAIN.md).


Expand Down