diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 34 |
1 files changed, 25 insertions, 9 deletions
@@ -1,37 +1,53 @@ # 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. +This tool is designed to facilitate learning songs, and solos in particular, by slowing down playback and automatically jumping to predefined points in the song. ## Dependencies -See requirements.txt and pacman.txt for required packages. +Python dependencies are listed in the pyproject.toml files of the different projects and should be automatically installed by `pip`. + +Non-Python dependencies are listed in pacman.txt and should be manually installed before running `make`. ## Usage -To use the GUI, run: +To set up the environment and run the tests, run `make`: + +``` +make +``` + +The web GUI can also be run with `make`: ``` -python solo_tool_qt.py +make web-dev ``` -Or for the (very basic) CLI: +Alternatively, the tool can be executed in headless mode. In this case all it does is load the provided session and connect to the MIDI controller: ``` -python solo_tool_cli.py +./venv/bin/solo_tool_cli ``` ## 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. +It is currently possible to control the tool with MIDI. With the device plugged in, a connection is automatically established by the CLI. Currently the only device supported is the Novation Launchpad Mini Mk II. + +The MIDI device button mapping is documented in `doc/diagram.drawio`. ## Tests For the automated tests, run: ``` -pytest *test.py +make test +``` + +or just + +``` +make ``` ## Architecture -More details on the architecture are available in `diagram.drawio`. +More details on the architecture are available in `doc/diagram.drawio`. |