Skip to content

Commit 1ec77df

Browse files
committed
readme corrections
1 parent 3df0b8c commit 1ec77df

1 file changed

Lines changed: 14 additions & 12 deletions

File tree

readme.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,22 @@ The microcontroller is now ready to receive note data from the virtual piano.
5555
## Building / Running
5656
### Computer
5757
#### Use the binary:
58-
[See Releases](https://github.com/baerkanogue/buzzer-piano/releases/)
58+
**[See Releases](https://github.com/baerkanogue/buzzer-piano/releases/)**
5959

6060
#### Or run from source:
61-
| Dependancy | Version |
62-
|--------|---------|
63-
| Python | 3.13.11 |
64-
| PyQt6 | 6.10.2 |
65-
| Pygame | 2.6.1 |
66-
| Pyserial | 3.5 |
67-
| Colorama | 0.4.6 |
68-
69-
Install dependencies:
61+
| Dependancy | Version | Notes |
62+
|------------|---------|-------|
63+
| Python | 3.13.11 |
64+
| PyQt6 | 6.10.2 | GUI
65+
| Pygame | 2.6.1 | Virtual piano framework
66+
| Pyserial | 3.5 | Sending data to MCU
67+
| Mpremote | 1.27 | Sending script to MCU
68+
| Colorama | 0.4.6 | stdout
69+
70+
**Install dependencies:**
7071
```bash
7172
python -m venv .venv
73+
source .venv/bin/activate
7274
pip install -r requirements.txt
7375
```
7476

@@ -86,5 +88,5 @@ chmod +x dist/buzzer_piano
8688
```
8789

8890
### Microcontroller
89-
- Micropython
90-
- Passive piezo buzzer
91+
- [Micropython](https://micropython.org/download/)
92+
- [Passive piezo buzzer](https://deepbluembedded.com/active-buzzer-vs-passive-buzzer/)

0 commit comments

Comments
 (0)