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
La plupart des développeurs OSRD utilisent Linux (y compris WSL). Vous pouvez utiliser Windows ou MacOS, mais pourriez rencontrer quelques problèmes.
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
Docker est un outil qui réduit considérablement la préparation nécessaire pour travailler sur OSRD:
- télécharger le dernier build de développement :
docker compose pull - démarrer OSRD :
docker compose up - compiler et démarrer OSRD:
docker compose up --build - review une PR avec les images compilées par la CI:
TAG=pr-XXXXX docker compose up --no-build --pull always
Pour commencer :
- Installer
docker - Suivre le README d’OSRD.