Skip to content

Commit 55214e6

Browse files
committed
updated readme for compilation
1 parent 378a642 commit 55214e6

2 files changed

Lines changed: 15 additions & 3 deletions

File tree

export.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ mv dist/buzzer_piano export/buzzer_piano
1313
cp misc/modules_licenses.txt export/licenses.txt
1414

1515
cd export
16-
tar -czvf buzzer_piano_VERSION.tar.gz .
16+
tar -czvf bp_linux_VERSION.tar.gz .
1717
rm buzzer_piano
1818
rm licenses.txt
1919
cd -

readme.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The microcontroller is now ready to receive note data from the virtual piano.
5353
## Requirements
5454
### Computer
5555
#### Use the binary:
56-
TODO
56+
[See Releases](https://github.com/baerkanogue/buzzer-piano/releases/)
5757

5858
#### Or run from source:
5959
- Python
@@ -68,7 +68,7 @@ pip install -r requirements.txt
6868
```
6969

7070
#### Or compile from source:
71-
#### Linux
71+
##### Linux
7272
```bash
7373
pyinstaller \
7474
--onefile \
@@ -80,6 +80,18 @@ main.py
8080
chmod +x dist/buzzer_piano
8181
```
8282

83+
#### Windows
84+
```pwsh
85+
pyinstaller \
86+
--onefile \
87+
--noconsole \
88+
--icon=misc\buzzer.icon \
89+
--add-data "misc\;misc" \
90+
--add-data "game\assets;game\assets" \
91+
--name "buzzer_piano." \
92+
main.py
93+
```
94+
8395
### Microcontroller
8496
- Micropython
8597
- Passive piezo buzzer

0 commit comments

Comments
 (0)