Comment créer un projet ?

Qu'est-ce qu'un projet?

La création d'un projet occasionne la mise en route de 4 applications interdépendantes.

• Une page Projet sur le Forum, qui présente les informations données
• Un forum de discussion du même nom dans la partie "discussion" (https://discussion.forum.ircam.fr/)
• Un répertoire de dépôt pour téléverser vos "releases"
• Un répertoire collectif de dépôt ou va être stocké le "ReadMe" (https://git.forum.ircam.fr/)
  Vous pouvez ensuite utiliser ce dépôt pour y stocker un projet collectif (voir https://forum.ircam.fr/article/detail/faq-how-to-create-a-collective-project/)

Une "release" est une version de votre contenu (logiciels, banque de sons, schémas techniques, patchs et programs). Vous pourrez par la suite, ajouter de nouvelles versions si vous faites évaluer celui-ci.

Préparer un projet

Avant de créer un projet, assurez vous que vous avez bien en votre possession:

• Sur votre ordinateur, un fichier archive contenant votre projet (zip, dmg, bz2...)
• Un texte décrivant son fonctionnement, comment l'installer et pour quel OS (mac, windows...). Cette documentation sera appellée "ReadMe" et doit être lue par l'utilisateur pour faire fonctionner votre projet.
• Tous les droits relatifs à tous les contenus de votre projet. Par défaut, la licence forum s'applique à tous les contenus. Toutefois, si votre fichier archive, contient à sa racine une autre license (BSD, MIT...), c'est cette dernière qui sera effective. 

Création d'un projet

A présent, cliquer sur le bouton bleu [+ Créer] en haut à droite de cette page, puis sur [PROJET]. Remplissez les champs usuels:

• Nom — ce nom doit être explicite pour permettre aux autres de le retrouver par l'outil de recherche.
• Description — une brève description qui sera affichée sur la page principale de votre projet et dans les résultats des moteurs de recherche.
• Tags — thèmatiques principales. Si un "tag" ou une balise n'existe pas déjà, elle sera créée.
• Dépôt de fichiers — c'est l'endroit ou sont stockés vos fichiers.
  • Créer un dépôt pour le projet (recommandé) — cela signifie que nous nous chargeons d'héberger vos fichiers. Il s'agit de l'option par défaut et recommandée. La suite de ce guide suppose que vous l'avez sélectionnée.
    
  • J'ai déjà un dépôt — dans le cas où vous avez déjà un dépôt quelque part sur Internet (pour le moment, seuls GitHub et forge-2 de l''Ircam sont pris en charge)
• README — la présentation de votre projet. Elle décrit votre intention ainsi que le fonctionnement des fichiers déposés. Pour information, ce champ va générer un fichier ReadMe.md en markdown et le stocké dans le répértoire collectif de dépôt.

Félicitations !

A ce stade, votre projet est créé sur le Forum et vous pouvez partager l'adresse url à d'autres personnes.

A tout moment, vous pouvez modifier/supprimer/mettre à jour ces données en cliquant sur [Préférences]

Dépôt de la première version

Une fois que le projet est créé, la première version doit être déposée. Pour cela, cliquez sur [Releases], puis sur [+ Create a new release]

• Nom — Donnez un nom à votre release. Par exemple "mon logiciel - version 1". Le nom de la release est le nom du fichier à télécharger à distinguer du nom du projet qui est le nom d'ensemble.
• Description — (optionnel) Vous pouvez donner une description spécifique à cette version.
• Release notes — (optionnel) Décrivez ici ce que cette version apporte de nouveau par rapport aux précédentes. (Vous pouvez laisser ce champ vide pour la première version).
• "Click to browse, or drop the file you want to add to the release": Indiquez ici le chemin ou glissez/déposez le fichier archive contenant votre release, afin de la téléverser sur le forum.

Une fois le fichier archive téléversé, vous pouvez finaliser la release en cliquant sur [ -> Create the release].

Paramétrisation du projet

Une fois le projet créé et la version téléversée, il ne vous reste plus qu'à paramétrer le bouton [download] afin qu'il adresse votre release:

Rendez vous dans [préférences] -> Bouton de téléchargement

Choisissez l'option: ["Download assets of the latest or a specific project release"]

En laissant le menu déroulant sur "Latest", vous êtes sur que les bénéficiaires téléchargeront la dernière version de votre projet.