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

Enhance Overview with README and project visuals

Browse source 
Added sections for README content and project pictures.
This commit is contained in:
Taran Mittal 2025-10-06 08:54:21 +11:00 • committed by GitHub
parent 87a4630c27
commit 1ee23d01f3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -17,7 +17,16 @@ First, you must have an approved PR for a macropad. It's okay if it hasn't been
- 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\
## 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