aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPatrick GENDRE2015-08-12 10:44:42 +0200
committerPatrick GENDRE2015-08-12 10:44:42 +0200
commit47dbb90c8d9c92165452f626aac11afdfff87d90 (patch)
treec519b78c548d01995aa629e0615bef24de1fe123 /README.md
parent21fc93024516e03fa2e7aaf71f46e4a53929c39c (diff)
downloadchouette-core-47dbb90c8d9c92165452f626aac11afdfff87d90.tar.bz2
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 29 insertions, 29 deletions
diff --git a/README.md b/README.md
index 988a6c5be..5f35e9da6 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,29 @@
# Chouette2 [![Build Status](https://travis-ci.org/afimb/chouette2.svg?branch=master)](https://travis-ci.org/afimb/chouette2) [![Dependency Status](https://gemnasium.com/afimb/chouette2.png)](https://gemnasium.com/afimb/chouette2) [![Code Climate](https://codeclimate.com/github/afimb/chouette2.png)](https://codeclimate.com/github/afimb/chouette2)
-Chouette2 is an open source web project in Ruby/Rails to edit and view transport offer. It's designed as an [SaaS](http://en.wikipedia.org/wiki/Software_as_a_service) platform and can :
-* Exchange transport data : [Neptune](http://www.chouette.mobi/spip.php?rubrique61), [GTFS](https://developers.google.com/transit/gtfs/reference?hl=fr), [NeTEx](http://www.kizoom.com/standards/netex/), CSV
+Chouette2 is an open source web project in Ruby/Rails to edit and view transport offer data. It is designed as an [SaaS](http://en.wikipedia.org/wiki/Software_as_a_service) platform and can :
+* Exchange transport data : [Neptune](http://www.normes-donnees-tc.org/format-dechange/donnees-theoriques/neptune/), [GTFS](https://developers.google.com/transit/gtfs/reference?hl=fr), [NeTEx](http://www.normes-donnees-tc.org/format-dechange/donnees-theoriques/netex/), CSV
* Edit transport data
-* Offer a [Restful API](https://en.wikipedia.org/wiki/Representational_state_transfer) in read-only
+* Be requested via a read-only [Restful API](https://en.wikipedia.org/wiki/Representational_state_transfer)
* [Import, Export and Validate transport data asynchronously](http://github.com/afimb/chouette)
-* Use [multi-tenancy database](http://en.wikipedia.org/wiki/Multitenancy)
+* Use a [multi-tenancy database](http://en.wikipedia.org/wiki/Multitenancy)
-It uses Rest Web Service API from another git project to import, export and validate various transport data [chouette](http://github.com/afimb/chouette)
+Chouette2 uses Rest Web Service API from [chouette](http://github.com/afimb/chouette) (another git project) to import, export and validate various transport data.
Feel free to test and access to the free SaaS web site at [http://appli.chouette.mobi](http://appli.chouette.mobi/chouette2/users/sign_in). Two types of access are granted :
-* A demo organisation with a set of data
+* A demo organisation with an existing Public Transport dataset
* login : demo@chouette.mobi
* password : chouette
-* Create your own organisation : Must follow the link "Sign up" ("S'inscrire")
+* Create your own organisation : follow the link "Sign up" ("S'inscrire")
Release Notes
-------------
-The release notes can be found in [CHANGELOG](./CHANGELOG.md) file
+The release notes (in French) can be found in the [CHANGELOG](./CHANGELOG.md) file
Requirements
------------
-* [Chouette Web Service IEV](https://github.com/afimb/chouette) 3.X (that requires Postgres and Java)
+* [Chouette IEV 3.X Web Service](https://github.com/afimb/chouette) (requires Postgresql and Java)
* Ruby 1.9.3 or 2.1.6
* Bundler 1.10.3
* Proj 4.8.0
@@ -31,12 +31,12 @@ Requirements
External Deps
-------------
-Install Chouette Web Service IEV [see how to](https://github.com/afimb/chouette/readme.md) 3.X.
+Install Chouette IEV 3.X Web Service [see how to](https://github.com/afimb/chouette/readme.md)
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)
+* a Chouette IEV Web Service is running (on localhost, port 8080)
+* a Postgres database exists (chouette2 on localhost, port 5432) with a postgres user (chouette, with password chouette)
-On Debian/Ubuntu/Kubuntu OS : assume depot contains the correct version
+On Debian/Ubuntu/Kubuntu OS : assumes that the depot contains the correct version
```sh
sudo apt-get install libpq-dev
sudo apt-get install git
@@ -46,7 +46,7 @@ sudo apt-get install libproj-dev
sudo apt-get install make
```
-If Linux distribution does't publish RVM package,
+If Linux distribution doesn't publish an RVM package,
install [RVM from sources](./doc/install/rvm.md)
Install ruby 2.1.6
@@ -63,7 +63,7 @@ gem install bundler -v 1.10.3
Installation
------------
-On debian, chouette can also be installed as a package : see [debian packages](http://packages.chouette.cityway.fr/debian/chouette)
+On Debian, chouette can also be installed as a package : see [debian packages](http://packages.chouette.cityway.fr/debian/chouette)
Install web application
@@ -93,21 +93,21 @@ Configure for Generating URLs in Action Mailer Views.
* Edit [production.rb](./config/environments/production.rb) and change ```config.action_mailer.default_url_options```
* see [Action Mailer Configuration documentation](http://guides.rubyonrails.org/action_mailer_basics.html)
-Configure assets access (Must be true if you use Webrick or false if you use Apache or Nginx).
+Configure assets access (Must be true if you use Webrick, or false if you use Apache or Nginx).
* Edit [production.rb](./config/environments/production.rb) and change ```config.serve_static_assets```
Configure SMTP settings.
* Edit [production.rb](./config/environments/production.rb) and change ```ActionMailer::Base.smtp_settings```
* see [Action Mailer Configuration documentation](http://guides.rubyonrails.org/action_mailer_basics.html)
-Configure e-mail address shown on mail sent when user registers, re-initialises its password, ...
+Configure e-mail send address visible on the e-mail sent when a user registers, re-initialises its password, ...
* Edit [production.rb](./config/environments/production.rb) and change ```config.mailer_sender```
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 address to Chouette Web Service IEV.
+Configure address of the Chouette IEV Web Service.
* Edit [secrets.yml](./config/secrets.yml) and uncomment and set```api_endpoint```
Configure Google Analytics Key.
@@ -118,7 +118,7 @@ Configure IGN Géoportail Key.
* Edit [secrets.yml](./config/secrets.yml) and uncomment and set```geoportail_api_key```
* see [API Géoportail documentation](http://api.ign.fr/accueil)
-Configure the way that it sends email.
+Configure the way that Chouette2 sends e-mail.
* Edit [devise_async.rb](./config/initializer/devise_async.rb) and uncomment and set```Devise::Async.enabled``` ( true if you want to use asynchronously and false otherwise )
* see [Devise Async specification](https://github.com/mhfs/devise-async)
@@ -129,18 +129,18 @@ Launch the task if you want to send mail asynchronously (See previous chapter to
```sh
RAILS_ENV=production bundle exec rake jobs:work
```
-This task may be added in system start up configuration
+This task may be added in system start-up configuration
-Launch rails server with [WEBrick](http://guides.rubyonrails.org/command_line.html#server-with-different-backends) ( default RoR web server, note: running on default port 3000)
+Launch rails server with [WEBrick](http://guides.rubyonrails.org/command_line.html#server-with-different-backends) ( default RoR web server, note: webrick runs on default port 3000)
```sh
RAILS_ENV=production bundle exec rails server
```
-This task may be added in system start up configuration.
-Instead of using WEBrick, Rails application may be deployed on [Pushion Passenger](https://www.phusionpassenger.com/) with an [Apache](http://httpd.apache.org/) or [NGinx](http://nginx.com/) front-end, to make server faster and more robust.
+This task may be added in system start-up configuration.
+Instead of using WEBrick, Rails application may be deployed on [Phusion Passenger](https://www.phusionpassenger.com/) with an [Apache](http://httpd.apache.org/) or [NGinx](http://nginx.com/) front-end, to make server faster and more robust.
-Apache like NGinx can serve static resources
-so, change parameter ```serve_static_assets``` to false in [production.rb](./config/environments/production.rb)
+Apache like NGinx can serve static resources,
+so change parameter ```serve_static_assets``` to false in [production.rb](./config/environments/production.rb)
Test
----
@@ -154,13 +154,13 @@ bundle exec rake spec
More Information
----------------
-More information can be found on the [project website](http://www.chouette.mobi/developpeurs).
-There is extensive usage documentation available [on the wiki](../../wiki).
+Complete docs (in French) can be found on the [project website](http://www.chouette.mobi/developpeurs).
+Some technical articles are available [on the wiki](../../wiki) too.
API Documentation
-----------------
-The description of the restful API is described in :
+The description (in French) of the read-only restful API is described in :
* [User manual file](./doc/interfaces/Chouette_API_REST_v1.2.pdf)
* [XSD file](./doc/interfaces/api_rest_v1.xsd)
@@ -172,7 +172,7 @@ This project is licensed under the CeCILL-B license, a copy of which can be foun
Release Notes
-------------
-The release notes can be found in [CHANGELOG](./CHANGELOG.md) file
+The release notes (in French) can be found in [CHANGELOG](./CHANGELOG.md) file
Support
-------