Update README with M-chip mac instruction focus#1197
Merged
Conversation
haitzlm
approved these changes
Apr 2, 2026
Contributor
haitzlm
left a comment
There was a problem hiding this comment.
Clear. Good change to not load the js files repeatedly.
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.
Update README: Add Apple Silicon M-Chip Setup Instructions
Summary
Complete rewrite of setup and installation documentation to provide clear, concise instructions optimized for Apple Silicon (M1–M4) Macs, with fallback instructions for Intel Macs. This resolves dependency installation failures that developers consistently encounter on new M-chip machines.
Rationale
The current README was written before Apple Silicon existed and contains:
The Problem:
[email protected]nio4r,posix-spawn,mysql2compilation)mysql20.5.x requires explicit linker paths forzstdand OpenSSL on M-chipsWithout guidance, developers spend 2–4 hours troubleshooting native extension builds.
Changes
Organization
Key Improvements
Testing This PR
rails serverstarts and http://localhost:3000 is reachablebundle exec rake specworksNotes for Reviewers
bundle install(not at runtime)Closes: LIBSCH1-70
The following are a series of screenshots of the updated README as it displays on GitHub. There is intentional duplication of the last line in the screenshot on the first line of the following screenshot to aid in getting the images in correct order. That duplication is not present in the README.