Skip to content

Phase 1 Milestone D: packaging and user documentation (P1-17, P1-18) - #10

Merged
Axoineo merged 2 commits into
mainfrom
p1/milestone-d-release
Nov 15, 2026
Merged

Axoineo merged 2 commits into
mainfrom
p1/milestone-d-release

Conversation

@Axoineo

@Axoineo Axoineo commented Nov 15, 2026

Copy link
Copy Markdown
Owner

What changed

Milestone D of docs/phases/phase-1.md, the last of Phase 1. Two commits.

P1-17, packaging

  • verone completions <shell> (bash, zsh, fish, elvish, powershell).
  • A release profile optimised for size: the binary goes from 2.4 MB to 1.3 MB.
  • packaging/arch/PKGBUILD: builds from this checkout and installs the binary, shell completions, README, changelog and NOTICE.

P1-18, documentation

  • README.md: requirements, installation, quick start and what to expect.
  • docs/user-guide/cli.md: every command, option, exit code and known limit.
  • SECURITY.md: what the privileged container, shared kernel, unauthenticated adb and unencrypted data mean for users, and how to report a vulnerability.
  • CONTRIBUTING.md: how the project is organised, checks, code rules, layout.
  • docs/architecture.md: final engine operations and repository layout.
  • docs/roadmap.md, docs/phases/phase-1.md, docs/README.md: Phase 1 marked as built.
  • CHANGELOG.md: the 0.1.0 section.

Why

Phase 1 ends when someone other than the author can install Verone and reach a running phone from the README alone.

Acceptance tests

Run on the reference laptop (Arch Linux, kernel 7.3.4, Docker 29.9.3, Rust 1.99.1).

$ cargo fmt --check                              (exit 0)
$ cargo clippy --all-targets -- -D warnings      Finished
$ cargo test
  verone-cli unit tests        46 passed
  verone-cli binary tests       9 passed
  verone-core                  74 passed; 1 ignored
  verone-engine-container      81 passed

$ cd packaging/arch && makepkg -f
==> Finished making: verone 0.1.0-1
verone-0.1.0-1-x86_64.pkg.tar.zst   659596 bytes

$ ls -la pkg/verone/usr/bin/verone                1297448 bytes  (limit: 10 MB)

$ VERONE=$PWD/packaging/arch/pkg/verone/usr/bin/verone tests/e2e/phase-1.sh
first exit 0, second exit 5
Phase 1 exit test passed.                         (exit 0)

Not verified, and left for the owner

  • Installing the package. sudo pacman -U needs root, which the build session does not have. The exit test was run against the binary inside the built package instead, which is the same file.
  • The "person following only the README" test. Nobody but the author has tried it yet.
  • The v0.1.0 tag. To be created by the owner after merging.
  • Private vulnerability reporting. SECURITY.md points to GitHub's "Report a vulnerability" button, which must be switched on in the repository's security settings.

Notes for the reviewer

  • The PKGBUILD builds from the local checkout, which suits development. A separate recipe that downloads the tagged release is needed for the AUR once the tag exists.
  • The only new crate is clap_complete, which is on the allow-list.
  • completions runs without a data home or a container runtime, and writes through a buffer so that a closed pipe does not cause a panic.
  • The user guide lists sound as unverified: Phase 0 test T-05 is still open.

🤖 Generated with Claude Code

Axoineo and others added 2 commits November 15, 2026 18:33
…1-17)

Add 'verone completions <shell>', a release profile optimised for size
(the binary drops from 2.4 MB to 1.3 MB), and packaging/arch/PKGBUILD,
which builds from this checkout and installs the binary, completions
for bash, zsh and fish, the README, the changelog and the NOTICE file.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Rewrite the README with requirements, installation and a quick start.
Add a command reference (docs/user-guide/cli.md), SECURITY.md stating
what the privileged container, shared kernel, unauthenticated adb and
unencrypted data mean for users, and CONTRIBUTING.md.

Update the architecture document with the final engine operations and
repository layout, mark Phase 1 as built in the roadmap and the plan,
and open the 0.1.0 section of the changelog.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@Axoineo
Axoineo merged commit f8810b8 into main Nov 15, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant