Repository navigation
docs: rewrite README for new contributors - #32
Merged
Merged
Conversation
Drop the npm command lists (package.json has them) and keep only what a new developer can't learn elsewhere: the spec, the dev-build requirement, generated native folders, the two-clock rule, Android release builds without INTERNET, the Emergency demo mode, iOS UIScene support, the privacy policy and palette tests, and where code lives. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
What changed
Rewrote
README.mdin plain, friendly language for an open source audience:package.json).ClockSnapshot), generatedios//android/, two-clock timing rule, no-delete corrections, Android release builds without INTERNET, Emergency demo mode env vars, iOS UIScene setting, privacy policy and palette tests, code layout, CI, license.How it was tested
Docs only. Checked each claim against the source (
src/domain/emergency.ts,src/platform/phone.ts,plugins/,app.json,tests/palette.test.ts,tests/privacyPolicy.test.ts,.eas/workflows/pr-builds.yml) and fetched both external links (privacy page title, expo/fyi page).🤖 Generated with Claude Code