From 1908d52e1dd7a499074e4353bb0a6c7f77040f0d Mon Sep 17 00:00:00 2001 From: Vit Brunner Date: Mon, 10 Jun 2013 22:58:31 +0100 Subject: [PATCH] Add readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1dd16f5 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Side By Side + +Visual comparison of different translations of itemized texts; e.g. poems, bibles, etc. + +## Usage + +*TODO: Include info on middlemanless usage.* + +## Development + +### Installation + +On Debian/Ubuntu, it goes more or less like this: + + # Install ruby, bundler, and ruby dependencies + sudo apt-get install ruby + sudo gem install bundler + bundle + + # Install nodejs and javascript dependencies + sudo apt-get install nodejs + npm install + +### Tests + +Start middleman with `middleman`, point your browser at `http://0.0.0.0:4567/tests.html`.