Expand README with features, architecture, and getting started#72
Merged
Conversation
…itecture tree Restructure the README around a fuller layout: a one-line pitch and name etymology up top, a native-tech summary of the engine, expanded feature bullets, explicit Requirements, a numbered Getting Started walkthrough, and an annotated source-tree Architecture section with a latency note. Also corrects the minimum-OS claim to macOS 15+ (badge included) to match Package.swift/project.yml after the macOS 15 support restore (#68). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SqgPLcuqqc8nehh388PWZM
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
2 participants
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.
What & why
This PR significantly expands the README to provide clearer documentation for users and developers:
The changes reorganize and expand existing information rather than introducing new features, making the project more accessible to both end users and contributors.
How it was tested
scripts/check.shpasses (or CI will, if I'm not on a Mac)No code changes; documentation only.
https://claude.ai/code/session_01SqgPLcuqqc8nehh388PWZM