basic README

2025-03-19 18:22:03 +01:00
parent db921e3390
commit e08f8be87d
3 changed files with 21 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,21 @@
+# Perfect Ear
+
+Train your ears to recognize piano notes !
+
+## Screenshots
+
+![[screenshots/success.png]]
+
+![[screenshots/failure.png]]
+
+## Build ⚙️
+
+```bash
+xmake # xmake will download all the required dependencies
+```
+
+## Run 🏃
+
+```bash
+xmake run
+```
--- a/screenshots/failure.png
+++ b/screenshots/failure.png
--- a/screenshots/success.png
+++ b/screenshots/success.png