Skip to content

Commit

Permalink
Documentation: delete of the source/readme.rst
Browse files Browse the repository at this point in the history
the source/readme.rst doc was useless.
Other small documentation modifications.
  • Loading branch information
antoine-de committed Dec 2, 2013
1 parent b302707 commit 809435b
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 63 deletions.
2 changes: 1 addition & 1 deletion build_package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
45 changes: 22 additions & 23 deletions install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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
31 changes: 18 additions & 13 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
26 changes: 0 additions & 26 deletions source/readme.rst

This file was deleted.

0 comments on commit 809435b

Please sign in to comment.