Repository navigation
Phase 1 Milestone D: packaging and user documentation (P1-17, P1-18) - #10
Merged
Merged
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).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).
Not verified, and left for the owner
sudo pacman -Uneeds 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.v0.1.0tag. To be created by the owner after merging.SECURITY.mdpoints to GitHub's "Report a vulnerability" button, which must be switched on in the repository's security settings.Notes for the reviewer
clap_complete, which is on the allow-list.completionsruns without a data home or a container runtime, and writes through a buffer so that a closed pipe does not cause a panic.🤖 Generated with Claude Code