Add readme

This commit is contained in:
Vit Brunner
2013-06-10 22:58:31 +01:00
parent b7c12f928b
commit 1908d52e1d
+26
View File
@@ -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`.