Skip to content

docs: improve installation guide with pre-built binaries#14

Open
njg7194 wants to merge 1 commit intoiximiuz:mainfrom
njg7194:docs/improve-installation-guide
Open

docs: improve installation guide with pre-built binaries#14
njg7194 wants to merge 1 commit intoiximiuz:mainfrom
njg7194:docs/improve-installation-guide

Conversation

@njg7194
Copy link
Copy Markdown

@njg7194 njg7194 commented Feb 1, 2026

Summary

This PR improves the installation documentation by adding instructions for pre-built binaries.

Changes

  • Added download instructions for pre-built binaries from GitHub Releases
  • Included platform-specific steps for Linux, macOS, and Windows
  • Added installation verification step
  • Reorganized the section with "Pre-built Binaries" as the recommended method

Motivation

The current installation guide only mentions building from source with Cargo. Since pre-built binaries are already available in GitHub Releases, documenting this makes it easier for users who don't have Rust installed to get started quickly.

Related

Addresses #8 (binary release request)

- Add instructions for downloading pre-built binaries from GitHub Releases
- Include platform-specific installation steps for Linux, macOS, and Windows
- Add verification step
- Reorganize installation section for better readability
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