* Prosongsa: Add Readme and example inputfile

1 files changed, 21 insertions, 0 deletions

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.