Added readme, updated issues

1 files changed, 37 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..74cabe8
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,37 @@
+# Solo Tool
+
+This tool is designed to facilitate learning songs, and solos in particular, by slowing down playback and automatically repeating short sections of the file.
+
+## Dependencies
+
+See requirements.txt and pacman.txt for required packages.
+
+## Usage
+
+To use the GUI, run:
+
+```
+python solo_tool_qt.py
+```
+
+Or for the (very basic) CLI:
+
+```
+python solo_tool_cli.py
+```
+
+## MIDI
+
+It is currently possible to control the tool with MIDI. With the device plugged in, a connection can be established by clicking on "Connect MIDI" in the GUI or entering "midi connect" in the CLI. Currently the only device supported is the Novation Launchpad Mini Mk II.
+
+## Tests
+
+For the automated tests, run:
+
+```
+pytest *test.py
+```
+
+## Architecture
+
+More details on the architecture are available in `diagram.drawio`.