about summary refs log tree commit diff
diff options
context:
space:
mode:
authorZach DeCook <zachdecook@gmail.com>2018-02-15 20:10:49 -0500
committerZach DeCook <zachdecook@gmail.com>2018-02-15 20:10:49 -0500
commit69ba0e96436687d31b4b898c9e05f18b6b2ec174 (patch)
tree4f36937aa8138cc9d4155fa893339460ecbff113
parentdf6ffc3da9d202aa1dd5bcfb363e938871681f44 (diff)
downloadprosongsa-69ba0e96436687d31b4b898c9e05f18b6b2ec174.tar.gz
* Prosongsa: Add Readme and example inputfile
-rw-r--r--README.md21
-rw-r--r--inputfile.example.txt44
2 files changed, 65 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.
diff --git a/inputfile.example.txt b/inputfile.example.txt
new file mode 100644
index 0000000..dda9662
--- /dev/null
+++ b/inputfile.example.txt
@@ -0,0 +1,44 @@
+Choruses and Hymns
+
+recommended line length less than 60 characters
+
+---
+
+X45. Amazing Grace
+-John Newton
+
+  A       E7   F#m  D        A
+Amazing grace how sweet the sound
+      B9                  E7sus   E7
+That saved a wretch like me
+  A         A7       C      A
+I once was lost but now am found
+      F#m      A/D  E7    A
+Was blind but now   I    see
+
+‘Twas grace that taught my heart to fear
+And grace my fears relieved
+How precious did that grace appear
+The hour I first believed
+
+The Lord has promised good to me
+His Word my hope secures
+He will my shield and portion be
+As long as life endures
+
+Through many dangers, toils, and snares
+I have already come
+‘Tis grace hath brought me safe thus far
+And grace will lead me home
+
+Yea, when this flesh and heart shall fail
+And mortal life shall cease
+I shall possess within the veil
+A life of joy and peace
+
+When we’ve been there ten thousand years
+Bright shining as the sun
+We’ve no less days to sing God’s praise
+Than when we’d first begun
+
+---