Persson-dev/GuitarPiano
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Simon Pribylski
2022-07-30 11:50:56 +02:00
committed by GitHub
parent aa03af0861
commit 61941d6488
1 changed files with 28 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -1,2 +1,29 @@
# GuitarPiano
Little french software to learn guitar from piano
GuitarPiano is a french software to learn guitar from piano. It uses [OpenGL](https://www.opengl.org) and [SDL](https://www.libsdl.org).
English translations will be added if really needed. For now, this is just a small project (the code is still a mess).
Also, feel free to contribute to the project !
# Screenshots
![Capture d’écran de 2022-07-30 11-41-27](https://user-images.githubusercontent.com/66266021/181904833-8ee95007-10b0-4937-9701-48d8d676104e.png)
![Capture d’écran de 2022-07-30 11-41-33](https://user-images.githubusercontent.com/66266021/181904805-676fffb9-c00e-414f-bdd5-19fb9a0f0f52.png)
# Build
You will need a recent compiler supporting c++17 and [xmake](https://xmake.io/#/getting_started).
Just cd into the project folder and type :
```
xmake
```
xmake should download all the depencencies for you.
# Run
```
xmake run -w test
```
# Install
Currently, there is no install script so you should just copy the binary.
The binary should be located in the build folder.