Update readme

This commit is contained in:
Vit Brunner
2013-06-13 20:56:42 +01:00
parent 6e6e6f4424
commit 577993ec99
+7 -10
View File
@@ -1,26 +1,23 @@
# Side By Side
Visual comparison of different translations of itemized texts; e.g. poems, bibles, etc.
Visual comparison of different translations of itemized texts; e.g. poems,
bibles, etc.
## Usage
*TODO: Include info on middlemanless usage.*
*TODO: Include info on nodeless usage.*
## Development
### Installation
On Debian/Ubuntu, it goes more or less like this:
Install nodejs and javascript dependencies, 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`.
Start docpad with `make run` and point your browser at
`http://0.0.0.0:9778/tests.html` or run `make test` in a separate shell.