From fbd3bf2cf17002449575493211d068c15aef1698 Mon Sep 17 00:00:00 2001 From: coderkun Date: Fri, 25 Dec 2020 19:44:42 +0000 Subject: [PATCH] Add README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fa465d9 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# TuxGuitar Drumsheets + +Application to clean drumset tracks in [TuxGuitar](https://sourceforge.net/p/tuxguitar/) files. + +## Requirements + +To build and run this application you need the following applications + +* Java +* Gradle +* TuxGuitar + +## Building + +To build the application with gradle, run the `build` task: + + $ gradle build + +To build the JavaDocs, run the `javaDoc` task: + + $ gradle javaDoc + +## Running + +To run the application with gradle, run the `run` task including argument via the `--args` parameter: + + $ gradle run --args="sourceFile [targetFile]" + +Example: + + $ gradle run --args="/home/user/Song.tg /home/user/Song-fixed.tg"