Repository navigation
docs: clarify the README and getting started - #73
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Disposition review of exact head The full diff changes README.md only. A separate GPT-6.1 Sol High reviewer independently checked the rewrite against source and maintained guides and found no merge blockers. This is independent Codex documentation review, not a human GitHub approval; the earlier draft-skipped CodeRabbit comment is not counted as source review. Validation: all 13 relative link targets and the setup anchor resolve; Node/Rust/pnpm pins match; launcher and backend commands, feature selection, loopback restriction, library ownership/root layout, experimental bindings, and narrower platform qualification match source. Nonblocking review notes: Repository CONTRIBUTING, Development, Architecture, binding and release guidance were read; no repository AGENTS.md exists. The external standards directory named by CONTRIBUTING is absent in this environment, so no independent assertion of external-standards compliance is made. The unchanged image redirects, but the reviewer could not retrieve its final hosted destination here. Existing owner work, branches, commits, CI evidence and scientific campaigns are preserved. |
[Low impact] The change reaches readers of the project guide, not running applications. The documentation change appears safe to merge, with a non-blocking correction needed for Linux build prerequisites. Findings
SummaryThe README now leads with sharing one model library and gives shorter desktop, backend, and integration instructions.
Reviews (1) · Last reviewed commit: "docs: make the README clearer and easier..." · Reviewed by Greptile |
| ## Standalone Backend | ||
|
|
||
| Build and run without Node, Corepack, frontend assets or Electron: | ||
| Use Rust 1.92.0, CMake and your platform's C/C++ build tools. No Node, frontend assets or Electron are needed: |
There was a problem hiding this comment.
Linux prerequisites miss OpenSSL
The new prerequisite lists here and in the desktop section omit pkg-config and OpenSSL development headers. pumas-rpc uses reqwest with native TLS enabled, which needs system OpenSSL even with --no-default-features. If a Linux machine has only the listed tools, the build can fail. Add these packages to both source routes—for example, pkg-config and libssl-dev on Debian/Ubuntu.
|
Final disposition: merged with a normal merge commit Post-merge CI on that exact merge SHA is complete and successful:
Final direct open-PR inventory is empty. Existing integration-owner work was left untouched. The documentation review and its nonblocking notes remain the scope of acceptance. No scientific campaign was rerun; skipped inference/release jobs and generic source CI do not extend trained-model, native UI, hardware, runtime-support or release qualification. No unresolved PR-disposition blocker remains. |
Summary
Verification