Skip to content

Commit

Permalink
Doc: add a getting started section
Browse files Browse the repository at this point in the history
since we have several questions about this, add a getting started
section.

feel free to push commit to this PR if you want to add some stuff
  • Loading branch information
antoine-de committed Jan 18, 2017
1 parent e7542ca commit fb9f35e
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 14 deletions.
8 changes: 6 additions & 2 deletions install.rst
Expand Up @@ -52,14 +52,18 @@ We hope you got the source code from git.
#. Run cmake

``cmake ../source``
Note: it will build in debug mode. If you want to compile it as a release run
``cmake -DCMAKE_BUILD_TYPE=Release ../source``
Note: it will build in release mode. If you want to compile it with debug symbols run
``cmake -DCMAKE_BUILD_TYPE=Debug ../source``

#. Compile

``make -j4``
Note: adjust -jX according to the number of cores you have

#. Run the tests

``make test``

Testing
=======

Expand Down
50 changes: 38 additions & 12 deletions readme.rst
Expand Up @@ -29,12 +29,45 @@ For more information see

* documentation http://doc.navitia.io
* main web site http://www.navitia.io
* playground http://canaltp.github.io/navitia-playground/
* twitter @navitia https://twitter.com/navitia
* google groups navitia https://groups.google.com/d/forum/navitia
* channel #navitia on irc.freenode.net

Organisation
============
Getting started
===============

Want to test the API ?
----------------------

The easiest way to do this is a to go to `navitia.io <https://www.navitia.io/>`_.
`Signup <https://www.navitia.io/register/>`_, grab a token, read the `doc <http://doc.navitia.io>`_ and start using the API!

For a more friendly interface you can use the API through `navitia playground <http://canaltp.github.io/navitia-playground/>`_

Want to use you own datasets or infrastructure ?
------------------------------------------------

docker
~~~~~~
The easiest way to do have your own navitia is to use the navitia `docker-compose <https://github.com/CanalTP/navitia-docker-compose>`_.

fabric
~~~~~~
If you don't want to use the prebuild docker images you can use the `fabric scripts <https://github.com/CanalTP/fabric_navitia>`_ we use to deploy to api.navitia.io.

*WARNING:* Those scripts should be usable, but they are not meant to be completly generics and are designed for own servers architecture.

Use this only if the docker is not fit for your needs and if you are an experienced user :wink:

Want to dev in navitia ?
------------------------
if you want to build navitia, please refer to the `installation documentation <https://github.com/canaltp/navitia/blob/dev/install.rst>`_

You can also check the `automated build script <https://github.com/canaltp/navitia/blob/dev/build_navitia.sh>`_ which is meant as a step by step tutorial for compiling and using navitia with ubuntu 16.04

Code Organisation
=================
At the root of the repository, several directories can be found:

#. source: contains the navitia source code (c++ and python)
Expand Down Expand Up @@ -65,25 +98,18 @@ More information here: https://github.com/CanalTP/navitia/wiki/Architecture

Tools
======
#. Gcc as the C++ compiler (g++)
#. Gcc (or clang) as the C++ compiler (g++)

#. Cmake for the build system

#. Python for the api

Installation
============
For the installation procedure, please refer to the `installation documentation <https://github.com/canaltp/navitia/blob/dev/install.rst>`_

Want to use Docker? Try this documentation https://github.com/CanalTP/navitia/wiki/Navitia-in-Docker-containers

You can also refer to the `automated build script <https://github.com/canaltp/navitia/blob/dev/build_navitia.sh>`_ to have a step by step setup guide for ubuntu 14.04


How to contribute
=================
Fork the github repo, create a new branch from dev, and submit your pull request!

Make sure to run the tests before submiting the pull request (`make test` in the build directory)

Are there many people contributing? Yes: https://www.youtube.com/watch?v=GOLfMTMGVFI

Alternatives?
Expand Down

0 comments on commit fb9f35e

Please sign in to comment.