docs: overhaul README with structured file documentation#4
Conversation
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
left a comment
There was a problem hiding this comment.
Beautifully organised and formatted.
|
While this revised document is pretty, it's meaningless if it is fundamentally incorrect in the information it claims to provide. The folder structure it describes is pretty much entirely incorrect, presumably due to AI hallucinations. The PCB files are not Kicad files, they are Eagle files, and likewise every subfolder is completely incorrectly described, aside from the least important one, the images folder. |
|
Damn, I always fall for the tell-tale bullet point slop. |
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!