aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMarc Florisson2015-07-06 09:41:03 +0200
committerMarc Florisson2015-07-06 09:41:56 +0200
commit86a61a54aa5234edc65a9db75c92dd9664e733bb (patch)
treebc01b7a257eed41ab2147ccb21a42417a74b5647 /README.md
parentb6956559bd92344ae8e80def0902173c42b28348 (diff)
downloadchouette-core-86a61a54aa5234edc65a9db75c92dd9664e733bb.tar.bz2
update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 21 insertions, 22 deletions
diff --git a/README.md b/README.md
index cb757d640..61c74684a 100644
--- a/README.md
+++ b/README.md
@@ -24,16 +24,29 @@ Requirements
------------
This code has been run and tested on [Travis](http://travis-ci.org/afimb/chouette2?branch=master) with :
-* Ruby 1.9.3 and 2.1.6
+* Ruby 1.9.3 or 2.1.6
* Bundler 1.10.3
-* Java 7
-* Postgres 9.3
* Proj 4.8.0
-* [Chouette Web Service IEV](https://github.com/afimb/chouette) 3.X
+* [Chouette Web Service IEV](https://github.com/afimb/chouette) 3.X (that requires Postgres and Java)
External Deps
-------------
+Install Chouette Web Service IEV [see how to](https://github.com/afimb/chouette/readme.md) 3.X.
+Next steps assumes that :
+* a Chouette Web Service IEV is running (on localhot port 8080)
+* a Postres database exists (chouette2 on localhot, port 5432) with a postgres user (chouette, with password chouette)
+
+On Debian/Ubuntu/Kubuntu OS : assume depot contains the correct version
+```sh
+sudo apt-get install libpq-dev
+sudo apt-get install git
+sudo apt-get install unzip
+sudo apt-get install proj-bin
+sudo apt-get install libproj-dev
+sudo apt-get install make
+```
+
If Linux distribution does't publish RVM package,
install [RVM from sources](./doc/install/rvm.md)
@@ -48,18 +61,6 @@ Install bundler 1.10.3
gem install bundler -v 1.10.3
```
-On Debian/Ubuntu/Kubuntu OS : assume depot contains the correct version
-```sh
-sudo apt-get install postgresql-9.3
-sudo apt-get install libpq-dev
-sudo apt-get install openjdk-7-jdk
-sudo apt-get install git
-sudo apt-get install unzip
-sudo apt-get install proj-bin
-sudo apt-get install libproj-dev
-sudo apt-get install make
-```
-
Installation
------------
@@ -77,13 +78,10 @@ Download gem librairies
```sh
bundle install
```
-Create [Postgres database user] (./doc/install/postgresql.md)
-
-Create database and its schema
+Update database schema
```sh
-RAILS_ENV=production bundle exec rake db:create db:migrate
+RAILS_ENV=production bundle exec rake db:migrate
```
-
Prepare static resources (assets)
```sh
RAILS_ENV=production bundle exec rake assets:clobber assets:precompile
@@ -110,7 +108,7 @@ Configure Rails secret key.
* Edit [secrets.yml](./config/secrets.yml) and uncomment and set```secret_key_base```
* see [Rails documentation](http://guides.rubyonrails.org/4_1_release_notes.html#config-secrets-yml)
-Configure API Endpoint for Chouette Web Service IEV
+Configure address to Chouette Web Service IEV.
* Edit [secrets.yml](./config/secrets.yml) and uncomment and set```api_endpoint```
Configure Google Analytics Key.
@@ -188,3 +186,4 @@ Credits
-------
Thanks to Ingolf for his [photo](https://www.flickr.com/photos/ingolfbln/7663851694) under CC BY-SA 2.0 license
+