Skip to content

Commit 2082b78

Browse files
committed
readme dependencies table
1 parent 7f2d65d commit 2082b78

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

readme.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@ The system is split into two parts:
66
- **Computer application** — Graphical piano interface and serial controller
77
- **Microcontroller mpy script** — Receives note data and generates sound using PWM
88

9-
109
https://github.com/user-attachments/assets/6d5003f8-bf1f-4924-867a-da4762076cf4
1110

12-
1311
## Overview
1412

15-
Allows the user to play a virtual piano on a computer while producing physical sound through a passive piezo buzzer connected to a microcontroller (ESP, Raspberry Pi Pico, or similar).
13+
Play a virtual piano on the computer while producing physical sound through a passive piezo buzzer connected to a microcontroller (ESP, Raspberry Pi Pico, or similar).
1614

1715
1. The desktop app connects to a microcontroller over a serial (USB) port.
1816
2. A virtual piano keyboard is displayed.
@@ -33,9 +31,9 @@ Allows the user to play a virtual piano on a computer while producing physical s
3331
Run the main script or executable. A GUI window will open and prompt you for the following information:
3432
1. **Number of octaves** to display on the virtual piano (starting from octave 3)
3533
2. **Serial port**, for example:
36-
> */dev/ttyACM0*
34+
*`/dev/ttyACM0`*
3735

38-
After clicking **DONE**, the application will attempt to connect to the microcontroller.
36+
After clicking **`DONE`**, the application will attempt to connect to the microcontroller.
3937
If the connection is successful, the virtual piano interface will appear.
4038

4139
The application is then ready to send note data to the microcontroller.
@@ -57,11 +55,13 @@ The microcontroller is now ready to receive note data from the virtual piano.
5755
[See Releases](https://github.com/baerkanogue/buzzer-piano/releases/)
5856

5957
#### Or run from source:
60-
- Python 3.13
61-
- PyQt6
62-
- Pygame
63-
- Pyserial
64-
- Colorama
58+
| Dependancy | Version |
59+
|--------|---------|
60+
| Python | 3.13.11 |
61+
| PyQt6 | 6.10.2 |
62+
| Pygame | 2.6.1 |
63+
| Pyserial | 3.5 |
64+
| Colorama | 0.4.6 |
6565

6666
Install dependencies:
6767
```bash
@@ -84,4 +84,4 @@ chmod +x dist/buzzer_piano
8484

8585
### Microcontroller
8686
- Micropython
87-
- Passive piezo buzzer
87+
- Passive piezo buzzer

0 commit comments

Comments
 (0)