docs(readme): reorganise installation section#72
Merged
Conversation
Move pip/uv installation to the top as the primary method. Relocate Nix development setup to a new "Development" section at the bottom, making it clear Nix is for contributors. Also add direnv allow instruction for automatic environment activation.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the README's installation documentation to better distinguish between end-user installation and contributor setup. The pip/uv installation method is now prominently featured as the primary installation approach, while Nix development environment setup has been moved to a dedicated Development section at the end of the document.
Key changes:
- Moved Nix installation instructions from Installation section to new Development section
- Added
direnv allowinstruction for automatic environment activation - Clarified that Nix setup is recommended for contributors/developers
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Move pip/uv installation to the top as the primary install method. Relocate Nix setup to a new "Development" section at the bottom, clarifying it's for contributors rather than end users. Also adds
direnv allowinstruction for automatic environment activation.Summary by cubic
Reorganized the README installation flow to make pip/uv the primary method for users. Moved Nix setup to a new Development section for contributors and added a direnv allow step for automatic environment activation.
Written for commit 2cfcec1. Summary will update automatically on new commits.