docs: improve README setup and usage#106
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 766d4177df
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview), or | ||
| [Pi](https://pi.dev/) installed, authenticated, and runnable by the user that | ||
| will run Push | ||
| - `curl` and `tar` for the release installer |
There was a problem hiding this comment.
Add Git to the quickstart prerequisites
For users installing the prebuilt release on a machine without git, following this Quickstart reaches push init, which unconditionally executes git init in src/assistant.rs, so setup fails even though all listed requirements are satisfied. Please include Git in the general requirements rather than only the source-build paragraph.
Useful? React with 👍 / 👎.
Summary
Why
The README explained the product well but delegated most setup and usage details to the documentation site. This gives new users a concrete path from installation to a working gateway and makes common operations easier to find.
Test plan
cargo fmt --all --checkcargo clippy --locked --all-targets -- -D warningscargo build --lockedcargo test --locked(245 unit tests and 11 integration tests)cargo build --locked --releasebash tests/install.shmkdocs build --strictgit diff --checkRisks
Documentation-only change. A live Telegram or iMessage gateway was not started because that requires external account and platform state. Browser screenshots and a narrow viewport check were unavailable for the GitHub file view, but the rendered DOM had no page overflow or console errors.
Related issue
None.