Skip to content

Commit 1182bd2

Browse files
committed
add readme and images
1 parent c98c37a commit 1182bd2

File tree

5 files changed

+42
-8
lines changed

5 files changed

+42
-8
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,28 @@
33
https://hackpad.hackclub.com/ <- website is live! This is probably a better place to start
44

55
## Overview
6-
This is a limited-time introductory YSWS (you ship, we ship) where *you* design your own macropad, and we'll ship it to you for free! This is something you definitely don't want to miss out, so make sure to join #hackpad in the slack!
76

7+
This is a limited-time introductory YSWS (you ship, we ship) where _you_ design your own macropad, and we'll ship it to you for free! This is something you definitely don't want to miss out, so make sure to join #hackpad in the slack!
88

99
### You ship:
10+
1011
- A PCB Design and schematic
1112
- Files for a case, either in STL or DXF format.
1213
- Firmware for the keyboard. You are allowed to use QMK or other pre-existing firmware!
1314

1415
### We'll send you:
16+
1517
- 3 PCBs! Keep one for yourself, or share some with your friends. Or you can keep them all, I won't judge.
1618
- a Seeed XIAO RP2040 microcontroller. They're pretty nifty microcontrollers, so you can use them for something else too
1719
- Switches! Choices TBD, but you'll have a great selection
1820
- Other components you may need, such as LEDs, diodes, knobs, OLED screens, and more!
1921
- Your case! You can either have it 3D printed, laser cut in acrylic, or both.
2022
- A grab bag of DSA keycaps, and a custom Hack Club keycap too.
2123

22-
23-
You can get the macropads soldered if you don't have a soldering iron, or we can send you the parts directly if you're up for a soldering task. The only catch is that if you want it to be soldered, you *must* use through-hole components only!
24+
You can get the macropads soldered if you don't have a soldering iron, or we can send you the parts directly if you're up for a soldering task. The only catch is that if you want it to be soldered, you _must_ use through-hole components only!
2425

2526
### Requirements:
27+
2628
- You design a macropad that integrates a [Seeed XIAO RP2040](https://wiki.seeedstudio.com/XIAO-RP2040/) as the main MCU. Nothing else allowed, sorry!
2729
- It has 20 or less inputs. A single input includes a rotary encoder, switch etc.
2830
- It is meaningfully unique to you. This could be as simple as making a custom layout and adding some decor, or as elaborate as writing an entire firmware in Rust
@@ -32,13 +34,8 @@ You can get the macropads soldered if you don't have a soldering iron, or we can
3234

3335
Once that's done, you can go on and make a PR. The instructions will be in the template.
3436

35-
3637
## Anything else?
3738

3839
This YSWS is only guaranteed to run through October 21st, so make sure to get yours submitted before then. Depending on skill level, this should take roughly 6-12 hours to finish.
3940

4041
List of questions from the slack that you may want answered too:
41-
42-
43-
44-
770 KB
Loading
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Inspiration
2+
3+
- I wanted to create my own personalised macropad.
4+
5+
Challenges
6+
7+
- First time using Kicad and fusion 360 so i had to learn alot before i could get started.
8+
9+
Specifications
10+
BOM:
11+
12+
- 6x Cherry MX switches
13+
- 1x XIAO RP2040
14+
- 6x blank DSA keycaps
15+
- OLED 128x64
16+
- 6x Diode_DO-35
17+
Others:
18+
- KMK firmware
19+
- Top of case stl file
20+
- bottom of case stl file
21+
- cover of case stl file
22+
- assembled case stl file
23+
24+
Images:
25+
26+
<table>
27+
<tr>
28+
<th>Casing</th>
29+
<th>Schematics</th>
30+
<th>PCB</th>
31+
</tr>
32+
<tr>
33+
<td><img src='CAD/cad pictures/3d.png'></td>
34+
<td><img src='PCB/pcb picture/schematics.png'></td>
35+
<td><img src='PCB/pcb picture/pcb.png'></td>
36+
</tr>
37+
</table>

0 commit comments

Comments
 (0)