Update Overview.mdx

This commit is contained in:
Taran Mittal 2025-10-06 08:49:42 +11:00 committed by GitHub
parent 2d52f4240f
commit 1081a39ba3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -5,6 +5,28 @@ Welcome to the keyboard section of hackpad! This section isn't completely finish
## Eligibility
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:
-[x]It has a complete CAD assembly, with all components (including electronics)
-[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!
## 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)
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
- Documenting what your project actually is:
- A quick story/motivation on how the project came to be
- A description of what the project does
- A quick brief on how it all fits together
- Some pictures of the design
- Making all files & resources easily accessible & organized
- Putting it on a platform that's easily shareable (i.e github)
## Deadline
Tentatively, the deadline is March 16th, but Feb 16th if you're only making a macropad. if you're making a full-sized keyboard. This may be extended, but it's unlikely