diff options
| author | Luc Donnet | 2013-05-27 16:57:23 +0200 | 
|---|---|---|
| committer | Luc Donnet | 2013-05-27 16:57:23 +0200 | 
| commit | 04665f0fb084496275daf9b71d1cd635f2da8cbc (patch) | |
| tree | cf9445e5ef4dd8f368d420946dbe7d64ca46e052 | |
| parent | 37b1e34a052c3155a9758f5e1175460af9e2cd30 (diff) | |
| download | chouette-core-04665f0fb084496275daf9b71d1cd635f2da8cbc.tar.bz2 | |
Fix link for documentation
| -rw-r--r-- | Gemfile | 1 | ||||
| -rw-r--r-- | Gemfile.lock | 8 | ||||
| -rw-r--r-- | LICENSE.md | 14 | ||||
| -rw-r--r-- | README.md | 44 | 
4 files changed, 51 insertions, 16 deletions
| @@ -69,6 +69,7 @@ group :development do    gem 'capistrano-ext'       gem 'guard'    gem 'guard-rspec' +  gem 'rails-erd'         end  group :test, :development do diff --git a/Gemfile.lock b/Gemfile.lock index 9aebe2e77..85743a6ad 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -66,6 +66,7 @@ GEM        xpath (~> 0.1.4)      childprocess (0.3.5)        ffi (~> 1.0, >= 1.0.6) +    choice (0.1.6)      cocoon (1.1.2)      coffee-rails (3.2.2)        coffee-script (>= 2.2.0) @@ -211,6 +212,11 @@ GEM        activesupport (= 3.2.6)        bundler (~> 1.0)        railties (= 3.2.6) +    rails-erd (1.1.0) +      activerecord (>= 3.0) +      activesupport (>= 3.0) +      choice (~> 0.1.6) +      ruby-graphviz (~> 1.0.4)      railties (3.2.6)        actionpack (= 3.2.6)        activesupport (= 3.2.6) @@ -257,6 +263,7 @@ GEM        rspec-core (~> 2.13.0)        rspec-expectations (~> 2.13.0)        rspec-mocks (~> 2.13.0) +    ruby-graphviz (1.0.9)      rubyzip (0.9.9)      sass (3.2.1)      sass-rails (3.2.5) @@ -347,6 +354,7 @@ DEPENDENCIES    pg (~> 0.11.0)    rabl    rails (= 3.2.6) +  rails-erd    ransack    rb-fsevent    rb-inotify diff --git a/LICENSE.md b/LICENSE.md index 2d4537d91..f69527a70 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,16 +1,16 @@  # Licence -Copyright "AFIMB":http://www.developpement-durable.gouv.fr/Presentation-de-l-AFIMB.html +Copyright [AFIMB](http://www.developpement-durable.gouv.fr/Presentation-de-l-AFIMB.html)  contributeurs / contributors : -* "DRYADE":http://www.dryade.net -* "MobiGIS":http://www.mobigis.fr -* "Cityway":http://www.cityway.fr +* [Dryade](http://www.cityway.fr) +* [MobiGIS](http://www.mobigis.fr) +* [Cityway](http://www.cityway.fr)  Ce logiciel est un programme informatique servant à créer et à échanger des données de modélisation d'offres de transport en commun en respectant les préconisations de la norme NEPTUNE [ref AFNOR en cour] .  -Ce logiciel est régi par la licence CeCILL-B soumise au droit français et respectant les principes de diffusion des logiciels libres. Vous pouvez utiliser, modifier et/ou redistribuer ce programme sous les conditions de la licence CeCILL-B telle que diffusée par le CEA, le CNRS et l'INRIA sur le site "http://www.cecill.info":http://www.cecill.info . +Ce logiciel est régi par la licence CeCILL-B soumise au droit français et respectant les principes de diffusion des logiciels libres. Vous pouvez utiliser, modifier et/ou redistribuer ce programme sous les conditions de la licence CeCILL-B telle que diffusée par le CEA, le CNRS et l'INRIA sur le site [http://www.cecill.info](http://www.cecill.info).  En contrepartie de l'accessibilité au code source et des droits de copie, de modification et de redistribution accordés par cette licence, il n'est offert aux utilisateurs qu'une garantie limitée. Pour les mêmes raisons, seule une responsabilité restreinte pèse sur l'auteur du programme, le titulaire des droits patrimoniaux et les concédants successifs. @@ -22,10 +22,10 @@ Le fait que vous puissiez accéder à cet en-tête signifie que vous avez pris c  This software is a computer program whose purpose is to to manage and disseminate public transfort offers according to the french NEPTUNE standard [AFNOR reference in progress]. -This software is governed by the CeCILL-B license under French law and abiding by the rules of distribution of free software.  You can  use,  modify and/ or redistribute the software under the terms of the CeCILL-B license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info":http://www.cecill.info .  +This software is governed by the CeCILL-B license under French law and abiding by the rules of distribution of free software.  You can  use,  modify and/ or redistribute the software under the terms of the CeCILL-B license as circulated by CEA, CNRS and INRIA at the following URL [http://www.cecill.info](http://www.cecill.info).  As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty  and the software's author, the holder of the economic rights, and the successive licensors have only limited liability.   In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate,and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software's suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security.  -The fact that you are presently reading this means that you have had knowledge of the CeCILL-B license and that you accept its terms.
\ No newline at end of file +The fact that you are presently reading this means that you have had knowledge of the CeCILL-B license and that you accept its terms. @@ -4,7 +4,7 @@ Chouette2 is a web project in Ruby/Rails and can :  * Exchange transport data : Neptune, GTFS, Netex, CSV  * Edit transport data  * Validate transport data -* Offer a Rest API +* Offer a Restful API in read-only  * Import and Export Data asynchronously                  Requirements @@ -27,8 +27,9 @@ sudo apt-get install git  Installation  ------------ -Install [Postgres] (https://github.com/dryade/chouette2/install/postgresql.md) -Install [JRuby] (https://github.com/dryade/chouette2/install/jruby.md) +Install [Postgres] (https://github.com/dryade/chouette2/doc/install/postgresql.md) + +Install [JRuby] (https://github.com/dryade/chouette2/doc/install/jruby.md)  Get git code :   ```sh @@ -36,7 +37,8 @@ cd workspace  git clone -b V2_0_3 git://github.com/dryade/chouette2  ``` -Install chouette-gui-command +Install chouette-gui-command to import and export transport offer :  +```sh  sudo mkdir -p /usr/local/opt/chouette-command/  cd /usr/local/opt/chouette-command/ @@ -45,7 +47,7 @@ sudo mv chouette-cmd_2.0.3 chouette-gui-2.0.3  cd chouette-cmd_2.0.3  sudo chmod a+x chouette  sudo chmod a+w . - +```  **JRuby** @@ -56,11 +58,13 @@ sudo apt-get install proj-bin  sudo apt-get install libproj-dev  sudo apt-get install make  ``` +  Build War ( Use RAILS_ENV production mode and parameters )  ```sh   jgem install bundler --version 1.2.4  jgem install jruby-openssl   bundle install --path vendor/bundle +bundle exec rake db:create  bundle exec rake war  ``` @@ -77,10 +81,14 @@ sudo chmod a+x /var/lib/chouette/imports /var/lib/chouette/exports /var/lib/chou  ```sh  gem install bundler  bundle exec rake db:create -bundle exec rake jobs:work -bundle exec rails server  ``` +Test +---- + +```sh +bundle exec rake spec +```  More Information  ---------------- @@ -88,15 +96,33 @@ More Information  More information can be found on the [project website on GitHub](http://github.com/dryade/chouette2).   There is extensive usage documentation available [on the wiki](https://github.com/dryade/chouette2/wiki). +API Documentation +----------------- + +You can view the [xsd file](https://github.com/dryade/chouette2/doc/interfaces/api_rest_v1.xsd) for the API + + + +  Example Usage  ------------- +------------- + +```sh +bundle exec rake jobs:work +bundle exec rails server +```  License  ------- -This project is licensed under the CeCILL-B license, a copy of which can be found in the LICENSE file. +This project is licensed under the CeCILL-B license, a copy of which can be found in the [LICENSE](http://github.com/dryade/chouette2/LICENSE.md) file. +Release Notes +------------- + +The release notes can be found in [CHANGELOG](http://github.com/dryade/chouette2/CHANGELOG.md) file  +   Support  ------- | 
