System-End/hackpad
1
0
Fork 0
mirror of https://github.com/System-End/hackpad.git synced 2026-04-19 21:05:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #716 from Overlord-Runt/main

Browse source 
site maybe?
This commit is contained in:
alex ren 2025-10-05 17:55:30 -04:00 • committed by GitHub
commit ec6f55595c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
website/src/pages/hackboard/Overview.mdx
View file

@ -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