Skip to content

docs: Simplify README with table of contents#25

Merged
kennethdsheridan merged 7 commits intomainfrom
kenny/readme-cleanup
Jan 6, 2026
Merged

docs: Simplify README with table of contents#25
kennethdsheridan merged 7 commits intomainfrom
kenny/readme-cleanup

Conversation

@kennethdsheridan
Copy link
Contributor

@kennethdsheridan kennethdsheridan commented Jan 6, 2026

Summary

Streamlines the README from 666 lines to ~100 lines with a clean structure matching other project READMEs.

Changes

  • Added table of contents with anchor links
  • Condensed quick start to 3 essential options (pre-built, Nix, Cargo)
  • Combined redundant installation sections
  • Added runtime dependencies table
  • Retained all Nix and traditional build instructions in concise form

@semanticdiff-com
Copy link

Review changes with  SemanticDiff

@kennethdsheridan kennethdsheridan self-assigned this Jan 6, 2026
@kennethdsheridan kennethdsheridan merged commit bb128da into main Jan 6, 2026
1 check passed
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