Repository navigation
feat(install): add install script and split README into docs guides - #83
Merged
Merged
Conversation
This change introduces a new installation script and reorganizes the documentation into focused guides. The main additions are the Homebrew and GitHub install-script paths, plus a dedicated test for the installer. **New installation tooling:** * Added `scripts/install.sh` to download and verify stable release binaries for macOS/Linux amd64/arm64, with `--version`, `--dir` and `--force` options, checksum verification against bounded `SHA256SUMS`, and legacy `jev_...` asset fallback when the new name is absent. * Added `scripts/test_install.py` to cover the installer behavior. **Documentation restructure:** * Trimmed the README to installation, verification and a documentation index, pointing to the new guides. * Split the former monolithic README into `docs/usage.md`, `docs/configuration.md`, `docs/sdk.md`, `docs/development.md`, `docs/debug.md`, `docs/updates.md`, `docs/releases.md` and `docs/mcp.md`. * Updated `docs/mcp-agents.md` cross-references to the relocated sections.
benbenbang
enabled auto-merge (rebase)
October 9, 2026 16:34
github-actions
Bot
added
documentation
|
🎉 This PR is included in version 1.5.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
This change introduces a new installation script and reorganizes the
documentation into focused guides. The main additions are the Homebrew
and GitHub install-script paths, plus a dedicated test for the installer.
New installation tooling:
scripts/install.shto download and verify stable releasebinaries for macOS/Linux amd64/arm64, with
--version,--dirand--forceoptions, checksum verification against boundedSHA256SUMS,and legacy
jev_...asset fallback when the new name is absent.scripts/test_install.pyto cover the installer behavior.Documentation restructure:
index, pointing to the new guides.
docs/usage.md,docs/configuration.md,docs/sdk.md,docs/development.md,docs/debug.md,docs/updates.md,docs/releases.mdanddocs/mcp.md.docs/mcp-agents.mdcross-references to the relocated sections.