diff --git a/website/src/pages/hackboard/Overview.mdx b/website/src/pages/hackboard/Overview.mdx index 6fa4a0a3..25f21325 100644 --- a/website/src/pages/hackboard/Overview.mdx +++ b/website/src/pages/hackboard/Overview.mdx @@ -5,6 +5,37 @@ 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: +- 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: +- 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 README.md FILE CONTAINS THE FOLLOWING: +- A short description of what your project is +- A couple sentences on why you made the project + +### PICTURES OF YOUR PROJECT +- A screenshot of a full 3D model with your project +- A screenshot of your PCB +- A BOM in table format at the end of the README + +## 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