commit 47a50b5140fbfa47838b3e23394bfcd83241a58d parent 0b558ca6e233601f43abdd16228a6a915765e9ab Author: gstraube <gstraube@users.noreply.github.com> Date: Sun, 20 Aug 2017 19:22:30 +0200 Add README Diffstat:
| A | README.md | | | 22 | ++++++++++++++++++++++ |
1 file changed, 22 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,22 @@ +# Cythara +A guitar tuning app for Android + +## Functionality + +* Supports standard guitar tuning (see https://en.wikipedia.org/wiki/Guitar#Standard) +* Changes background color from red to green to indicate that the string is in tune (with a tolerance of 3 cents) +* Displays deviations between -30 and 30 cents + +## Tests + +Run `./gradlew test` to run all unit tests. In addition, there are UI tests based on image comparisons which +can be run using `./gradlew connectedCheck`. The reference images are generated using a Nexus 5X emulator +(resolution: 1080 x 1920, 420 dpi) with API level 26. + +## Libraries + +The Tarsos DSP library (https://github.com/JorenSix/TarsosDSP) is used for pitch detection. + +## License + +Cythara is licensed under the GPL, version 3. A copy of the license is included in LICENSE.txt.