Update Overview.mdx

This commit is contained in:
Taran Mittal 2025-10-06 08:52:27 +11:00 committed by GitHub
parent b23155d54a
commit 87a4630c27
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -6,16 +6,16 @@ Welcome to the keyboard section of hackpad! This section isn't completely finish
First, you must have an approved PR for a macropad. It's okay if it hasn't been delivered to you yet! Just make sure it's merged
## YOUR PROJECT IS ACTUALLY COMPLETE:
<input type="checkbox" enabled> It has a complete CAD assembly, with all components (including electronics) <br>
-[x] You have firmware present, even if it's untested
-[x] You have sanity checked your design with someone else
-[x] (optional) you have a 3D render of your project!
- It has a complete CAD assembly, with all components (including electronics)
- You have firmware present, even if it's untested
- You have sanity checked your design with someone else
- (optional) you have a 3D render of your project!
## YOUR GITHUB REPOSITORY CONTAINS ALL OF YOUR PROJECT FILES:
-[x] a BOM, in CSV format in the root directory, WITH LINKS
-[x] the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc)
-[x] A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc)
-[x] ANY other files that are part of your project (firmware, libraries, references, etc)
- a BOM, in CSV format in the root directory, WITH LINKS
- the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc)
- A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc)
- ANY other files that are part of your project (firmware, libraries, references, etc)
Your keeb must also be shipped\
In short, shipping is process of **actually making your project sharable.** It's the most important part of your project, almost as important as the entire project itself