diff --git a/README.md b/README.md index 2262458..323b56b 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -# MusicBoxController +

Music Box Controller

+ +

project-image

+ + +## 🖥️ Compatibility + +- Tested on **Raspberry Pi Pico W** +- Any microcontroller with MicroPython should work in theory + + +## 🛠️ Installation + +1. Clone the repository `git clone https://github.com/MusicBoxRaspberryPi/MusicBoxController` +2. Rename `config.py.dist` to `config.py` +3. Edit `config.py` to your needs +4. Copy contents of `src` to your microcontroller + +

schematic

+

schematic2

+ +## 🚀 Usage + +- **Left button** - Previous device +- **Right button** - Next device +- **RFID Scan** - Play track diff --git a/images/schematic.png b/images/schematic.png new file mode 100644 index 0000000..662e5d8 Binary files /dev/null and b/images/schematic.png differ diff --git a/images/schematic2.png b/images/schematic2.png new file mode 100644 index 0000000..04cf8b7 Binary files /dev/null and b/images/schematic2.png differ