Commit af421489 authored by natalie's avatar natalie 💜
Browse files

rephrase parts of readme

parent 99116265
......@@ -4,15 +4,15 @@
## Assembly guide
[Click here for the assembly guide.](https://git.agiri.ninja/natalie/MegaGRRL_Desktop/wikis/Assembly-guide) Bill of materials can be found [here](https://git.agiri.ninja/natalie/MegaGRRL_Desktop/wikis/BOM)
## Firmware flashing/changes
The portable and desktop MegaGRRL versions share a single codebase, contained in the [normal MegaGRRL repo](https://git.agiri.ninja/natalie/megagrrl). Before compiling, `main/hal.h` must be edited to specify that the desktop version is built. More details on this are available in the readme.
The portable and desktop MegaGRRL versions share a single codebase, contained in the [normal MegaGRRL repo](https://git.agiri.ninja/natalie/megagrrl). Before compiling, `main/hal.h` must be edited to specify that the desktop version is built. More details on this are available in the MegaGRRL project repo's readme.
A simplified flashing guide is available for Windows users [here](https://git.agiri.ninja/snippets/3).
## PCB manufacturing considerations
The board doesn't really have anything too weird on it, but do watch out that your PCB house does the plated slots for the headphone jack correctly. The DRC rules are set for tented vias - these are preferable for aesthetics, but are otherwise not required. Please note if exporting your own gerbers that the art for the top and bottom of the PCB are on layers 200 (top) and 201 (bottom). Pre-exported gerbers for JLCPCB can be found in the `gerbers/` directory.
The board is a fairly standard 2-layer board. Please ensure that your PCB manufacturer handles the plated slots on the headphone jack correctly. The DRC rules are set for tented vias - these are preferable for aesthetics, but are otherwise not required. Please note if exporting your own gerbers that the art for the top and bottom of the PCB are on layers 200 (top) and 201 (bottom). Pre-exported gerbers for JLCPCB can be found in the `gerbers/` directory.
## 3D Printing
`mgd_base.stl` is an STL file for a 3D-printable baseplate for the MegaGRRL Desktop board. This provides a nice flat bottom surface and also supports the PCB underneath areas that undergo flexing (buttons, IC sockets). Please note that this was designed in mil, so in most slicers you will need to resize this to 2.54% to get it in millimeters. The original OpenSCAD source file is also available. 100% infill is recommended, and printing with a brim may help bed adhesion. Supports are needed due to the recessed screw holes.
## License
The schematic, PCB, and baseplate are licensed under CC BY-NC-SA 4.0. You are free to build this project for yourself or friends, but please do not sell it or misrepresent its origin. If you are interested in selling assembled players, please contact hello@kunoichilabs.dev
The schematic, PCB, and baseplate are licensed under CC BY-NC-SA 4.0. You are free to build this project for yourself or friends, but please do not sell it or misrepresent its origin. If you are interested in manufacturing players for sale, please contact hello@kunoichilabs.dev
## Beware Fake Chips!
[WIP guide on detecting fake chips](https://git.agiri.ninja/natalie/MegaGRRL_Desktop/-/wikis/Identifying-fake-YM2612s)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment