did an oopsie with readme

This commit is contained in:
Doron Malka 2024-10-23 19:16:28 +03:00
parent d7554e4d6d
commit 938aed44f0
2 changed files with 59 additions and 15 deletions

View file

@ -1,16 +1,44 @@
# MusicPad
This was my first time doing everything here so i learnt a ton, will def use the pcb making skill again for
my other electronics projects
# Hackpad
https://hackpad.hackclub.com/ <- website is live! This is probably a better place to start
## Overview
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!
### You ship:
- A PCB Design and schematic
- Files for a case, either in STL or DXF format.
- Firmware for the keyboard. You are allowed to use QMK or other pre-existing firmware!
### We'll send you:
- 3 PCBs! Keep one for yourself, or share some with your friends. Or you can keep them all, I won't judge.
- a Seeed XIAO RP2040 microcontroller. They're pretty nifty microcontrollers, so you can use them for something else too
- Switches! Choices TBD, but you'll have a great selection
- Other components you may need, such as LEDs, diodes, knobs, OLED screens, and more!
- Your case! You can either have it 3D printed, laser cut in acrylic, or both.
- A grab bag of DSA keycaps, and a custom Hack Club keycap too.
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!
### Requirements:
- You design a macropad that integrates a [Seeed XIAO RP2040](https://wiki.seeedstudio.com/XIAO-RP2040/) as the main MCU. Nothing else allowed, sorry!
- It has 20 or less inputs. A single input includes a rotary encoder, switch etc.
- 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
- The PCB only uses 2 layers
- The PCB does not exceed 100mm in length in any direction
- Don't make a macropad with 40 screens. Or out of pure gold. Please!!
Once that's done, you can go on and make a PR. The instructions will be in the template.
## Anything else?
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.
List of questions from the slack that you may want answered too:
### things on the pad:
* 7 switches
* two rotary encoders that also have switches
* a gpio expander
* also a screen lol
## What stuff does
the bottom three switches are for music control - rewind (a whole song), play/pause, and skip.
the rotary encoders are for volume, left is master right is only music.
pressing the rotary encoders mutes their volume (all of it / just music).
the rest i havent decided yet, prob for other macros for specific things.

View file

@ -0,0 +1,16 @@
# MusicPad
This was my first time doing everything here so i learnt a ton, will def use the pcb making skill again for
my other electronics projects
### things on the pad:
* 7 switches
* two rotary encoders that also have switches
* a gpio expander
* also a screen lol
## What stuff does
the bottom three switches are for music control - rewind (a whole song), play/pause, and skip.
the rotary encoders are for volume, left is master right is only music.
pressing the rotary encoders mutes their volume (all of it / just music).
the rest i havent decided yet, prob for other macros for specific things.