Update documentation:
* Remove rails default doc files; * Fix outdated documentation (installation and contribution).
This commit is contained in:
@@ -1,14 +1,10 @@
|
||||
Contributing to scube
|
||||
---------------------
|
||||
|
||||
* Clone scube official repository and create a branch from master for
|
||||
your changes.
|
||||
* Clone scube-server official repository and create a branch from
|
||||
master for your changes.
|
||||
|
||||
* Make sure all cucumber features pass:
|
||||
|
||||
`bundle exec rake cucumber`
|
||||
|
||||
* And rspec examples as well:
|
||||
* Make sure all rspec examples pass:
|
||||
|
||||
`bundle exec rake spec`
|
||||
|
||||
|
13
doc/INSTALL
13
doc/INSTALL
@@ -1,7 +1,7 @@
|
||||
scube installation
|
||||
------------------
|
||||
scube-server installation
|
||||
-------------------------
|
||||
|
||||
You'll need ruby, rubygems and bundler gem installed.
|
||||
You'll need ruby, rubygems and the bundler gem installed.
|
||||
|
||||
|
||||
* After you have cloned the repository, install required dependencies
|
||||
@@ -9,15 +9,12 @@ scube installation
|
||||
|
||||
`bundle install`
|
||||
|
||||
* Alternatively, you can run `bundle check` and manually install the
|
||||
missing dependencies.
|
||||
|
||||
* Then you'll need to create the database and run the migrations. Edit
|
||||
config/database.yml to suit your needs and execute the db:migrate
|
||||
`config/database.yml' to suit your needs and execute the db:migrate
|
||||
rake task using bundler:
|
||||
|
||||
`bundle exec rake db:migrate`
|
||||
|
||||
* Eventually you can launch the application:
|
||||
|
||||
`./script/rails server`
|
||||
`rails server`
|
||||
|
@@ -1,2 +0,0 @@
|
||||
Use this README file to introduce your application and point to useful places in the API for learning more.
|
||||
Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.
|
Reference in New Issue
Block a user