Merge branch 'hackclub:main' into tutorial-fix

This commit is contained in:
Sid Senthil 2025-02-10 18:14:42 -08:00 committed by GitHub
commit 7c86ed5522
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 5 additions and 27 deletions

View file

@ -1,18 +0,0 @@
on:
workflow_dispatch: # Allows you to trigger the workflow manually
jobs:
comment:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Comment on all open PRs
run: |
PRS=$(gh pr list --state open --json number -q '.[].number')
for PR in $PRS; do
gh pr comment $PR --body "Hey!! Nice job on your hackpad submission. This is alexren // @qcoral sending this automation to let you know that the submission guidelines have been updated, please follow https://hackpad.hackclub.com/submitting again. Sorry for the confusion!! Hopefully this won't be needed again."
done
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View file

@ -53,19 +53,14 @@ It has an OLED, a rotary encoder, 4 switches in a matrix, 2 addressable LEDs, an
- Generally speaking, go to [grabcad](https://grabcad.com/library) and search for your part + sort by popular, and you should be able to find the model you need
## Generally useful tips
- Most DIY keyboards are at least partially open source.
You can go to their git repositories and copy their tolerances/footprints/schematics/whatever
- Most DIY keyboards are at least partially open source. You can go to their git repositories and copy their tolerances/footprints/schematics/whatever
- You can export your KiCad PCB to a PDF and print them to check measurements
- Most Keyboards are wired in a matrix to save pins, but if you have 6 or less switches just avoid the matrix altogether
- For screens, just use a 4-pin header for footprints
- Adding graphics in KiCad is really annoying. Instead, you can design your entire thing in Figma and import it as an overlay instead
- Google is your best friend, search up anything u don't know.
- Spam vias everywhere! They are free.
- Google is your best friend. 9 times out of 10 the first result will help you out.
- Try routing everything on one layers first, if you can't without making a big loop, move to the second layer. This keeps your board clean.
- Make multiple revisions! I rerouted my first macropad like 10 times while adding stuff.
- After routing everything, run Tools > Cleanup Tracks & Vias. You gotta press the Build changes button twice for the optimizations to apply.
- Use a ground fill, they are good!
- Try adding capacitors, they will increase your board's stability.
- With kmk, you can control your mouse with buttons! See [Mouse Keys](https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/mouse_keys.md) in the docs.
- Maybe use some thicker traces! Edit the trace width a at the top left "Track: use netclass width", click edit predefined and add yours. Then select it in the same menu.
- Use tunnels to keep your schematic organised.

View file

@ -108,7 +108,8 @@ You should have the following menu open:
<img src="/docs/v2/editgrid.png" className="max-w-96" />
Now click on the + button at the bottom left, and enter "2.38125" in the field named "X". Press Ok then Ok again. Now you have defined a cutom grid!
Now click on the + button at the bottom left, and enter "2.38125" in the field named "X". Press Ok then Ok again. Now you have defined a custom grid!
(this is the distance between the switches divided by 8. 19.05mm / 8 = 2.38125mm)
We now need to place the components!
@ -187,7 +188,7 @@ You currently can view the 3D version of your PCB by pressing Alt+3 (Option+3 on
Oh no! We are missing some 3D Models. Here we will learn how you add them.
First, you must find 3D Models for your components on the internet, but here if @Cyao's trusty list of common models. (If this opens a new tab and doesn't automatically download, press Control+S)
First, you must find 3D Models for your components on the internet, but here is @Cyao's trusty list of common models. (If this opens a new tab and doesn't automatically download, press Control+S)
- [Seeed-Studio Xiao](https://rawcdn.githack.com/cheyao/macropad/642f4e5dbdabb88147ccd878850d199042967667/PCB/third_party/xiao.step)
- [Cherry MX v2 (Models for the switches)](https://rawcdn.githack.com/cheyao/macropad/3adb7e07d888458e6d1985f4e6be17601a1c2350/PCB/third_party/SW_Cherry_MX_PCB.stp)