diff --git a/README.md b/README.md index 309dd10..8ee963b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,51 @@ # Tiny Music app -This is an app to easily create backing tracks to play along to certain chords. +This is an app to play live backing tracks to play along to. -Features: +## Building and installation -- Enter an arbitrary chord progression -- Synthesize sounds on the go -- Preview which chords will be played soon -- Use effects on instruments +This is a gradle android project written in kotlin. You will need to install Android studio and +setup your build environment. Then, you can install the app on your phone. -Gplv3+ Licensed \ No newline at end of file +## APK build: TODO + +## Usage + +Important note: To hear anything, make sure you have started the song on the play tab, +added at least one instrument which plays at least one note per measure and isn't muted +and have at least one line inserted into your song. + +### The play view + +This is the default view. Here, you can start or stop playing. + +#### Beat indicator + +![](images/play/beat.png) + +This shows you which beat is currently played. + +#### Volume and speed controls + +![](images/play/volume-tempo.png) + +Adjust your volume between 0% and 100%. This will apply to all instruments. + +The tempo is adjusted in beats per minute (BPM). + +#### Chord preview + +![](images/play/chords.png) + +Here, you can see which chords will be played next. Underneath the current line, you can also see +a preview of the first chord in the next line to be prepared. + +#### Song navigation + +![](images/play/navigation.png) + +For all song navigation, the song will not change its current beat. This means that if you + +Use the simple fast-forward buttons to skip to the next measure and advance to the next chord. + +The skip-to end and beginning buttons will skip to the next or previous line of chords. \ No newline at end of file