diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..511e9cf --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +opentox-server: Common part for OpenTox webservices +=================================================== + +Installation: +------------- + + gem install opentox-service + +Development: +------------ + + git clone git@github.com:<my-opentox-service>.git + cd <my-opentox-service> + bundle install + ./bin/toxbank-investigation-install # if not already installed, do not start webserver + export RACK_ENV=development + # if you are working on opentox-server|client gems as well edit Gemfile e.g. + # gem 'opentox-server', :path => "~/opentox-server" + # gem "opentox-client", :path => "~/opentox-client" + # start webserver in development mode (runs at port 8080, should reload changes from source files) + unicorn + # open new terminal + git flow init + git flow feature start <your feature> + # code, test, code, ... + git flow feature finish <your feature> + # test + # create release branch + # increase version (in toxbank-investigation.gemspec) + # install into system gems + rake install + # test + # create master + # release + rake release + + +Documentation +------------- +* [API documentation](http://opentox.org/dev/api) +* [RubyDoc.info Code documentation](http://rubydoc.info/github/opentox/opentox-server/development/frames) |