diff options
| author | gebele <gebele@in-silico.ch> | 2016-10-31 16:09:18 +0000 |
|---|---|---|
| committer | gebele <gebele@in-silico.ch> | 2016-10-31 16:09:18 +0000 |
| commit | 678a9e60be4a9a6b0c59969a0f6e0266885337fa (patch) | |
| tree | 7e16ae9ce6e5946d250d9be9031ec6f4b520e9a4 /README.md | |
| parent | d05b5b91249a846b68c755d3716abc7343670a2a (diff) | |
updated README; added service commands for the gem
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ce3e52c --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +nano-lazar +========== + + nano-lazar for [eNanoMapper](http://www.enanomapper.net/) project. + +Dependencies +------------ + + nano-lazar depends on a couple of external programs and libraries. All required libraries will be installed with the `gem install nano-lazar` or `bundle install` command. The output should give you more verbose information that can help in debugging (e.g. to identify missing libraries). + +Installation +------------ + + ``` + gem install nano-lazar + ``` + + or + + ``` + git clone https://github.com/enanomapper/nano-lazar.git + cd nano-lazar + bundle install + ``` + +Service +------- + + ``` + nano-lazar-start + nano-lazar-stop + ``` + + or + + ``` + cd nano-lazar + unicorn -D + ``` + +Browser +------- + Point your browser to `localhost:8080` (default) or any other port passed within the unicorn start command. + +Documentation +------------- + * [API documentation](http://rdoc.info/gems/nano-lazar) + +Copyright +--------- + + Copyright (c) 2009-2016 Christoph Helma, Micha Rautenberg, Denis Gebele. See LICENSE for details. |