Licence et mise en place

Comment mettre en place l’environnement de développement ? Qu’implique notre licence ?

La licence des contributions de code

Tout le code du dépot OSRD est mis à disposition sous la licence LGPLv3. En contribuant du code, vous acceptez la redistribution de votre contribution sous cette license.

La licence LGPL interdit de modifier OSRD sans publier le code source de l’application modifiée : profitez du travail des autres, et laissez les autres profiter de votre travail !

Cette contrainte n’est pas contagieuse à travers les API : Il est possible d’utiliser OSRD comme bibliothèque, framework ou serveur pour s’interfacer avec des composants propriétaires. N’hésitez pas à proposer des changements pour répondre à vos besoins.

Mise en place

Obtenir le code source

  • Installer git1
  • Ouvrir un terminal2 dans le dossier qui contiendra le code source d’OSRD
  • git clone git@github.com:osrd-project/osrd

Lancer l’application

Grâce à docker, on peut facilement compiler, configurer, et lancer les différents composants après un changement. On peut aussi choisir de lancer seulement une partie des composants.

Continuer vers la contribution au code ‣

  1. Sous Linux, suivez les guides pour votre distribution dans la documentation de Docker ↩︎ ↩︎

  2. Sous Windows, ouvrez Git Bash ↩︎

  3. Sous Windows/WSL, Docker Desktop est recommandé ↩︎