Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Mise en place de la session pratique

CMAP/CNRS/Ecole polytechnique

Dans le premier chapitre, nous avons fait le tour des outils à mettre en place pour définir le cadre de développement, favoriser et faciliter les interactions entre les différents acteurs gravitant autour d’un projet open source. Nous en avons présenté certain plus en détail.

Pour la suite, nous supposerons que

Nous allons à présent décrire l’ensemble des étapes nécessaires pour vous simplifier la vie et celle de vos utilisateurs et contributeurs.

Présentation du projet

Nous allons nous appuyer sur un code C++ déjà écrit et prêt à l’emploi qui fait du generative art à partir de l’équation d’un cercle et de splines. Ce programme affiche des rendus de ce type

L’idée vient du site inconvergent.

Dans ce projet, l’arborescence est la suivante

Les dépendances du projet sont

Le projet ne décrit pas encore son environnement de développement : c’est la première chose que vous allez faire.

Initialisation du projet

Nous allons commencer par mettre l’ensemble des fichiers se trouvant dans le répertoire material/0.initialization/required_files dans un répertoire que vous aurez créé et qui se trouve en dehors du répertoire git que vous venez de cloner.

Vous pouvez maintenant initialiser le système de gestion de version pour ce répertoire en faisant

git init

Puis ajoutez l’ensemble des fichiers et faites votre premier commit.

Initialisation du dépôt distant

Vous allez à présent créer un dépôt sur votre compte GitHub. Nous vous proposons de l’appeler splinart-cpp. Une fois que c’est fait, il ne vous reste plus qu’à ajouter le dépôt distant dans votre répertoire en suivant les instructions proposées par GitHub.

Vous devrez ensuite configurer votre dépôt GitHub comme indiqué dans Configurer son dépôt GitHub.

Environnement de développement

Vous allez maintenant décrire avec pixi tout ce qu’il faut pour compiler, lancer et tester splinart-cpp. Si vous avez besoin d’un rappel sur les commandes, relisez la section pixi.

Dans le répertoire du projet, initialisez pixi

pixi init

pixi crée un fichier pixi.toml qui ne contient que votre plateforme. L’intégration continue tournera plus tard sous Linux, macOS et Windows : ajoutez ces plateformes dès maintenant pour que le fichier pixi.lock les couvre aussi.

pixi workspace platform add linux-64 osx-arm64 win-64

Ajoutez ensuite les dépendances avec pixi add

Les chapitres suivants utilisent aussi des outils de formatage, d’analyse statique et de documentation. Ajoutez-les maintenant pour ne plus avoir à y revenir : clang-format, clang-tools, pre-commit, sphinx, pydata-sphinx-theme, doxygen, breathe et myst-parser.

Il reste à définir les tâches dans la section [tasks] de pixi.toml. Elles passent toutes par CMake avec le générateur Ninja et construisent dans le répertoire .build.

Pour vérifier que tout fonctionne, lancez l’application

pixi run start

Une fenêtre doit s’ouvrir avec un cercle comme celui présenté plus haut. Lancez ensuite les tests

pixi run test

Quand tout fonctionne, ajoutez pixi.toml et pixi.lock dans un commit et poussez-le sur votre dépôt.

Vous êtes prêt pour la suite !