From 809435b5718a64a80904f96a2f3324a0f414cae8 Mon Sep 17 00:00:00 2001 From: Antoine Desbordes Date: Mon, 2 Dec 2013 09:53:17 +0100 Subject: [PATCH] Documentation: delete of the source/readme.rst the source/readme.rst doc was useless. Other small documentation modifications. --- build_package.rst | 2 +- install.rst | 45 ++++++++++++++++++++++----------------------- readme.rst | 31 ++++++++++++++++++------------- source/readme.rst | 26 -------------------------- 4 files changed, 41 insertions(+), 63 deletions(-) delete mode 100644 source/readme.rst diff --git a/build_package.rst b/build_package.rst index b68416a9ea..44e706c31d 100644 --- a/build_package.rst +++ b/build_package.rst @@ -20,7 +20,7 @@ Build instructions ``git-dch -R -N version --ignore-branch`` ``commit the changes made to debian/changelog`` 4. Build the new version - git-buildpackage --git-tag --git-ignore-branch + ``git-buildpackage --git-tag --git-ignore-branch`` 5. Files are available in the parent directory. diff --git a/install.rst b/install.rst index 3ba8eca375..368b458771 100644 --- a/install.rst +++ b/install.rst @@ -22,27 +22,26 @@ Build instruction We hope you got the source code from git. -1. Get the submodules: at the root of project : +#. Get the submodules: at the root of project : ``git submodule update --init`` -2. Create a directory where everything will be built and enter it +#. With CMake you can build in a repository different than the source directory. + By convention, you can have one build repository for each kind of build. + Create a directory where everything will be built and enter it ``mkdir release`` ``cd release`` -3. Run cmake +#. Run cmake ``cmake ../source`` - Note: il will build in debug mode. If you want to compile it as a release run - ``cmake -DCMAKE_BUILD_TYPE=Release ../source`` -4. compile +#. Compile ``make -j4`` - Note: adjust -jX according to the number of cores you have Testing @@ -52,21 +51,21 @@ Testing The data manager is called *ed*. It relies on GTFS and Open Street Map data centralized in a postgres database - #. Configure the postgres database +#. Configure the postgres database - #. TODO + #. TODO - #. Get some GTFS data. For instance from http://data.navitia.io +#. Get some GTFS data. For instance from http://data.navitia.io - Import them using the gtfs2ed tool + Import them using the gtfs2ed tool - #. Get some Open Street Map data. For instance from http://metro.teczno.com/ +#. Get some Open Street Map data. For instance from http://metro.teczno.com/ - Import them using the osm2ed tool + Import them using the osm2ed tool - #. Once *ed* has been loaded with all the data, you have to export the data for *Kraken* with the ed2nav tool +#. Once *ed* has been loaded with all the data, you have to export the data for *Kraken* with the ed2nav tool - This step will generate a ziped nav file that can be given as input to *Kraken* + This step will generate a ziped nav file that can be given as input to *Kraken* #. Running the *Kraken* backend @@ -80,18 +79,18 @@ Testing #. Edit if you want the Jormungandr.ini file. - Note: If you want to put the file elsewhere, you can change the INSTANCES_DIR variable + Note: If you want to put the file elsewhere, you can change the INSTANCES_DIR variable - example file : :: + example file : :: - [instance] - # name of the kraken - key = some_region - # zmq socket used to talk to the kraken, should be the same as the one defined by the zmq_socket param in kraken - socket = ipc:///tmp/default_kraken + [instance] + # name of the kraken + key = some_region + # zmq socket used to talk to the kraken, should be the same as the one defined by the zmq_socket param in kraken + socket = ipc:///tmp/default_kraken #. Give him the configuration file (by default it uses source/jormungandr/default_settings.py) and run it - ``JORMUNGANDR_CONFIG_FILE=your_config.py python jormungandr.py`` + ``JORMUNGANDR_CONFIG_FILE=your_config.py python jormungandr.py`` #. Grab a browser and open http://localhost:5000/v1/coverage/default_region diff --git a/readme.rst b/readme.rst index 2615f79a54..4593f0c66a 100644 --- a/readme.rst +++ b/readme.rst @@ -4,37 +4,42 @@ Navitia Presentation ============ +This is the Navitia repository. + Navitia is a service providing: - #. journeys computation +#. journeys computation + +#. line schedules - #. line schedules +#. next departures - #. next departures +#. explore public transport data - #. explore public transport data +#. sexy things such as isochrones - #. sexy things such as isochrones +The API can be found in http://api.navitia.io/ For more information see http://www.navitia.io/ Organisation ============ At the root of the repository, several directories can be found: - #. source: contains the navitia source code - #. third_party: third party developped modules +#. source: contains the navitia source code + +#. third_party: third party developped modules - #. documentation: all the navitia documentation +#. documentation: all the navitia documentation - #. (debug|release): by convention, the build repositories +#. (debug|release): by convention, the build repositories Tools ====== - #. Gcc as the C++ compiler (g++) +#. Gcc as the C++ compiler (g++) - #. Cmake for the build system +#. Cmake for the build system - #. Python for the api +#. Python for the api - #. Doxygen and swagger for the automated documentation +#. Doxygen and swagger for the automated documentation diff --git a/source/readme.rst b/source/readme.rst deleted file mode 100644 index d00eb2c14e..0000000000 --- a/source/readme.rst +++ /dev/null @@ -1,26 +0,0 @@ -******** -Navitia -******** - -Used libs -========= -#. Boost - -#. Protocol buffers - -#. Fastlz - -TODO presentation of the python libs - -CMake use -========= -With CMake you can build in a repository different than the source directory. -By convention, you can have one build repository for each kind of build : - - #. Debug directory - - ``mkdir debug; cd debug; cmake -D BUILD_TYPE=Debug ../source`` - - #. Release directory - - ``mkdir release; cd release; cmake -D BUILD_TYPE=Release ../source``