Info sur JMRI:
Outils de Développement
Structure
Techniques et Standards
Comment Faire
Infos Fonctionnelles
Contexte Infos

JMRI: Obtention du Code

Contexte

"Git" est un puissant système libre gérant du code comme s'il a à travailler dessus par un groupe distribué. Comme SVN avant lui, et CVS avant lui, il permet à un groupe comme JMRI de coopérer efficacement. Nous gardons le code JMRI, fichiers aides, exemple de scripts, fichiers XML, etc, dans un répertoire Git hébergé sur GitHub.com. Le site web JMRI est dans un répertoire similaire.

Affichage du Code en Ligne

Vous pouvez parcourir le code JMRI directement sur ce site. Par exemple, si vous souhaitez regarder cette page, cliquez sur ce lien pour afficher ses code source HTML.

Proposition de Changements en Ligne

Si vous voulez suggérer un changement dans un fichier, par exemple une page web comme celle ci, premièrement obtenez un compte GitHub libre et connectez-vous.

Puis allez au fichier que vous voulez modifier et cliquez sur l'icône crayon en haut à droite de la page.

Après une seconde ou deux, ceci vous donne une page où vous pouvez modifier les contenus du fichier avec vos suggestions de changements. Pas de panique, vous ne modifiez pas actuellement le code original de JMRI, juste votre copie personnel du code.

Puis remplissez le formulaire du bas avec une ligne d'objet utile, et une description de pourquoi c'est une bonne modification, et cliquez le bouton "Propose file change". Ceci sauve vos modifications dans votre copie personnel sur le serveur Git.
Ensuite, cliquez sur le bouton "Pull request" au sommet droit du panneau de code. Ceci envoie votre changement aux personnes qui sont agréées pour maintenir le code central JMRI, qui examineront et (généralement) l'inclurons dans la version suivante de JMRI (plus de détails).

Obtenir Votre Propre Copie

Notre source de code est distribuée en utilisant Git. ( Nous gardons aussi le site web dans Git, si vous aimez travailler avec la source pour ce répertoire. ) Si vous voulez travailler avec le code JMRI, le site web entier, ou une autre partie de JMRI, passer quelques minutes à obtenir la configuration Git vaut bien la peine. Nous sommes désolés, mais nous ne pouvons pas soutenir d'autres méthodes (envoi des fichiers individuels, etc.), car ils sont tout simplement trop source d'erreurs. </ p>

Bien qu'il y ait beaucoup de façons d'utiliser Git, les sections suivantes vous montre les plus communes:

Si vous voulez développer des changements dans le code, voir la page "Développement avec le Code JMRI."

Vérifiez aussi la page JMRI Git FAQ.

Utilisation de l'application GitHub Desktop

L'application GitHub Desktop est un outil très pratique pour travailler avec les répertoires Git. Malheureusement, il n'est disponible que pour Mac et Windows. Pour Linux, utilisez SVP une des autres méthodes.

Une fois que le téléchargement est terminé, il y a des éléments de menu sous le menu "Repository" de l'application pour accéder au code directement:
Repository menu in GitHub Desktop

Vous pouvez aussi naviguer directement là en utilisant votre fichier système.
À l'intérieur vous trouverez des répertoires appelés xml, resources, jython, help, lib, java et autres.

Dans le répertoire java, vous trouverez un répertoire src qui contient le code source pour JMRI lui-même, et un répertoire tests qui contient diverses routines de test.

Vous pouvez regarder le code avec votre éditeur de texte favori.
pour compiler et exécuter le code, vous devez besoin de l'un des outils de compilation décrits dans la barre à gauche: Ant, Eclipse, NetBeans, IntelliJ, etc, ( Ant peut être le plus facile à installer et utiliser, et il est le premier exemple de la documentation ).

Utilisation de la ligne de commande

Premièrement, vérifiez ou Git est installé sur votre ordinateur. Depuis une ligne de commande, faire
git --version (notez les deux tirets).
Si la réponse est une version plus grande que 2, ex 2.3.8, vous êtes prêt. Si non, il y a les instructions pour l'installation de Git dans la FAQ Git. Installez Git, et revenez ici.

Pour obtenir une copie locale du code, Vous dites à Git de le "cloner depuis notre répertoire. La commande pour le faire est:


        $ git clone https://github.com/JMRI/JMRI.git
        
Ceci créera un nouveau répertoire "JMRI" et y téléchargera le code.

Si vous avez déjà obtenu une copie du code sur votre ordinateur et voulez le mettre à jour, démarrez dans le répertoire du code JMRI et $ git pull https://github.com/JMRI/JMRI.git

Après que la vérification est terminée, allez au nouveau répertoire JMRI qui a été créé. À l'intérieur, vous trouverez: des répertoires appelés xml, resources, jython, help, lib, java et autres.

Dans le répertoire java, vous trouverez un répertoire src qui contient le code source pour JMRI lui-même, et un répertoire tests qui contient diverses routines de test.

Vous pouvez regarder le code avec votre éditeur des texte favori.

Pour compiler et exécuter le code, vous devez besoin de l'un des outils de compilation décrits dans la barre à gauche: Ant, Eclipse, NetBeans, IntelliJ, etc, ( Ant peut être le plus facile à installer et utiliser, et il est le premier exemple de la documentation ).

Utilisation d'un Environnement de Développement Intégré (IDE)

La plupart des IDEs ont un support Git fournit avec. Pour ceux qui peuvent construire JMRI nous avons des instructions spécifiques:

Accès Aux Anciennes Versions

La meilleure méthode pour retrouver la source pour les version 4.1.2 et avant est par le Répertoire SVN SVP Voir ces instructions pour plus de détails

La meilleure méthode pour retrouver la source pour les version 4.1.2 et avant est par le Répertoire CVS SVP Voir ces instructions pour plus de détails