IntelliJ IDEA Community Edition (disponible depuis www.jetbrains.com/idea/) est une grande plateforme pour travailler avec JMRI et Java sur OS X, Windows et *nix.
Les développeurs JMRI utilisent Git pour le contrôle de source. Le contrôle de source utilisant Git est inclus comme un élément du téléchargement IntelliJ IDEA. Plus d'information sur l'obtention de la source JMRI voir JMRI: Obtention du Code.
Ces instructions sont développées et testées par l'utilisation de IntelliJ IDEA 15 et 16 Community Edition (libre).
Après le téléchargement et l'exécution de l'installateur pour votre OS, configurez l'application IntelliJ comme suit:
Faites un don à JMRI.org˜/Users/Preferences/IdeaIC2016.1/˜/Library/Preferences/IdeaIC15/.idea64.vmoptions en idea.vmoptions ( enlevant efficacement la partie"64" ).$HOME/.IdeaICXX/idea$BITS.vmoptions pour *nix et %USERPROFILE%\.IdeaICXX\idea%BITS%.exe.vmoptions pour Windows (XX = le numéro de version, BITS = the chip version installed).Si l'environnement de variable IDEA_VM_OPTIONS est défini, ou un fichier *.vmoptions existe, alors ce fichier est utilisé au lieu du fichier localisé dans le dossier d'installationin de IntelliJ IDEA.
Plus d'information sur la définitions de ces importantes vmoptions est disponible sur le site web Idea.
Note: Si vous avez un doute sur comment définir ceci au niveau du projet au lieu de bricoler avec les paramètres locaux de l'application, SVP contactez les utilisateurs JMRI group.
Démarrer IntelliJ et choisir "Preferences" depuis le menu application (OS X) ou le menu Edit (Win).
Pour obtenir le code source depuis GitHub dans IntelliJ, suivre ces étapes:
Ceci ajoutera JMRI à la fenêtre IntelliJ Project.
Après que la duplication est terminée, la fenêtre IntelliJ Project
devrait ressembler à ceci ( exemple OS X ):
Le long des bords de la fenêtre, il y a plusieurs groupes d'outils, les plus souvent utilisés sont les suivants:
Vous pouvez aussi accéder à ce panneau depuis menu....Branches principales VCS -> Git -> Branches... menu ou clic-droit sur le dossie JMRI Project et sélection de Git -> Repository -> Branches...
Pour récupérer une autre Branche depuis le répertoire distant, sélectionnez son nom sous la rubrique «Branches à distance", clic-droit et sélectionnez "Checkout as new local branch":
quand l'information depuis la nouvelle Branche est téléchargée, le Centre des Messages confirmera:
Pour travailler sur le code JMRI, démarrez toujours une nouvelle Branche, ainsi votre "master" personnel restera intact.
Pour créer une nouvelle Branche dans IntelliJ, depuis le volet Git Branch, sélectionnez "New Branch":
Fournir un nom exemple: my-dialog-2 et cliquez OK.
Note: Le démarrage de votre nom de Branche avec une combinaison de deux lettres le fera se démarquer de la longue liste beaucoup mieux qu'un nom comme patch-1.
Nous recommandons qu'avant d'essayer de construitre et d'exécuter une des
applications au sein d'IntelliJ, vous exécutiez Ant Build -> <cible par Défaut> en premier. Ceci créera les répertoires de travail nécessaires, chargera quelques ressources,
icônes, et créra les fichiers Java nécessaires. Pour exécuter ant build.xml faire comme suit:
Si le ant build est réussi, vous pouvez lancer plusieurs applications JMRI depuis l'onglet Ant Build.
Pour exécuter une application, soit
panelpro ou
decoderpro et sélectionnez "Run Target".
Note: Les deux premiers "JMRI" définis construiront les fichiers JHelpDev TOC & Index respectivement en Anglais et en Français. Passez votre souris sur eux et lire l'info-bulle pour apprendre qui est qui.
La Console Message Center listera toutes les étapes du processus de construction, après quoi une icône Java s'ouvrira avec l'application s'exécutant avec toutes vos nouvelles modifications ( Sauvegardées ).
La pratique standard pour obtenir que vos changements soient inclus dans le répertoire
principal du code JMRI est de les "transmettre" ( commit ) vers votre répertoire local
périodiquement et, quand c'est prêt à être entièrement publié, "Tirer" ( Push ) un jeu complet de "Transmissions" ( Commits )
vers votre propre répertoire distant sur GitHub, et finalement
faire une "Requête Tirer" ( Pull Request ) pour les maintenanciers pour "Tirer" ( Pull ) vos changements dans le répertoire
principal JMRI.
Quand le travail se fait sur plus d'un ordinateur ou différents IDEs, Committing et Pushing rendent vos nouveau changements disponibles sur les autres ordinateurs.
Voir la JMRI: Git FAQ "Définition d'un environnement Git pour des
Développeurs JMRI" pour plus d'information.
Il est aussi de bonne practique de "Tirer" ( Pull ) tous les récents changement depuis le répertoire principal JMRI avant de réaliser vos transmissionss ( Commits ). Après un "tirer" "pull" votre espace de travail et éventuellement votre répertoire distant GitHub seront synchronisés avec le répertoire principale JMRI et vous verrez les travaux récents effectués par d'autres. Pour réaliser un "Tirage":
Pousser ( "Push" ) vers votre Branche GitHub:
Avant que vous puissiez "Pousser" vos changements dans GitHub pour la première fois, vous devez créer votre propre répertoire GitHub (que vous avez déjà fait à l'étape 1).
Soyez sûr que vous avez configuré IntelliJ pour convertir les caractères spéciaux utilisant les minuscules pour l'encodage des chaines, ainsi alors seulement vos modifications seront acceptées pour la fusion dans JMRI.
Pour modifier facilement les fichiers Resource Bundle .properties files, contenant les traductions en différentes langues, clic-droit sur un de ces dossiers (fermés) dans la liste des fichier Project et sélectionnez "Jump to Source":
Ceci ouvrir une fenêtre avec une liste de mots clés codés sur la gauche et une boite texte pour toutes les traductions à droite:
Quand lors de test de votre application vous concluez que vous aimeriez enlever le dernier couple de Commits, IntelliJ vous donne l'option de réinitialiser graphiquement votre HEAD.
Pour ce faire, ouvrez l'onglet "Version Control" -> "Log" en bas à gauche de la fenêtre Project pour voir un "Track Plan" de l'historique de votre Branche, tout le chemin de retour vers les différentes parties qui ont fait JMRI:
Cliquez sur n'importe quelle ligne pour voir les changements qui ont été "Transmis" à ce point dans le temps (listé à droite).
Pour réinitialiser votre répertoire ( HEAD ) de retour à un certain point, Clic-droit sur la ligne correspondante et sélectionnez Reset Current Branch to Here...".
Confirmez la manière que vous voulez pour sauvegarder ou jeter vos "transmissions" après ce point de dialogue :
Pour stocker en toute sécurité votre login GitHub, vous pourriez être invité régulièrement à le déverrouiller:
Finalement, quand c'est prêt, soumettez un "Pull Request" au répertoire principale du code JMRI sur le site web GitHub ansi les maintenanciers de JMRI peuvent étudiés vos changements proposés et les fusionnés dans le répertoire maitre JMRI
Pour faire un PR à partir de IntelliJ IDEA, sélectionnez "Create Pull Request" depuis le menu "VCS" -> Git menu (c'es le dernier élément, supportéé par le plug in Git ).
Pour faire un PR ( Pull Request ) depuis le site web GitHub en dehord de IntelliJ - commencez en vous connectant au site web GitHub, sélectionnez votre répertoire & branch et cliquez sur le Bouton Pull Request. Pour plus d'information, voir la page Git Developer Help.
Voir la référence web IntelliJ IDEA et autres ressources pour plus d'information sur l'utilisation de cet IDE.