From 69ba0e96436687d31b4b898c9e05f18b6b2ec174 Mon Sep 17 00:00:00 2001 From: Zach DeCook Date: Thu, 15 Feb 2018 20:10:49 -0500 Subject: * Prosongsa: Add Readme and example inputfile --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..3edbe11 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Prosongsa + +## Setup + +* Have the ability to serve php files. +* Clone this repository, including the submodules, into such a place. + + ```git clone --recursive https://github.com/earboxer/prosongsa.git``` + + If you've already cloned without the submodules, you can use + `git submodule update --init --recursive`. + +* Create file `inputfile.txt` in this directory + (see `inputfile.example.txt` for example format). +* Navigate to the page where index.php is being served from. + +## Acknowledgements + +* Github user [mzarillo](https://github.com/mzarillo) for + [ccharter](https://github.com/earboxer/ccharter) script. +* Ruslan Keba from http://guitar-chords-chart.net for guitar chords fingering data. -- cgit 1.4.1