docs: overhaul README with structured file documentation#4
Open
Ash1421 wants to merge 3 commits intosb-ocr:mainfrom
Open
docs: overhaul README with structured file documentation#4Ash1421 wants to merge 3 commits intosb-ocr:mainfrom
Ash1421 wants to merge 3 commits intosb-ocr:mainfrom
Conversation
Author
Hey Salim! 👋Important Please feel free to comment on this PR if you'd like anything added, removed, or changed before merging. Note The reason I put this together is because you seem like a genuinely cool person working on cool projects, and I'd love to help contribute where I can. If the style or approach isn't quite what you're looking for, I completely understand — no worries at all! |
rain-fade
approved these changes
Apr 11, 2026
rain-fade
left a comment
rain-fade
left a comment
There was a problem hiding this comment.
Beautifully organised and formatted.
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 this changes
Rewrites the README to make the repo easier to navigate for anyone who wants to build or remix the CM Deck.
Changes included
enclosure/STL/— print settings table and parts overviewfirmware/qmk/— file descriptions, build and flash instructionspcbs/— what each board does and how to order Gerbersboms/— column reference for the CSV filesNotes
File names in the repo tree are illustrative based on the visible folder structure. If anything is inaccurate, missing, or not quite right, please feel free to leave a comment and I'll get it updated!