search JMRI:

Development tools

• Getting the code via Git
• Developing with JMRI Code
• Git FAQs
• Building with:
  • Ant
  • NetBeans
  • Eclipse
  • IntelliJ IDEA

Code Structure

• Introduction
• Names and Naming
• Application Structure
• Code Structure Patterns
• Swing Structure
• External Connection Structure
• Application Preferences
• Threading
• Use of XML
  • XML Schema
  • XSLT Formatting
• Web Site
• Javadocs
  • Name Index
  • Packages
  • Classes

Techniques and Standards

• Recommended Practices
• Continuous Integration
• Internationalization
• Logging & Error Handling
• Unit testing with JUnit
• Documentation with Javadoc and UML
• Run the SpotBugs static analysis tool
• Providing help with JavaHelp
• Portable Filename Method
• XML Persistance

How To

• Extend JMRI
• Add a New System
• Add a New Type

Functional Info

• Turnout Feedback
• Network Connections
• How the startup scripts work
• LogixNG

Background Info

• Technology Roadmap
• Survey of JVM Capabilities
• Usage Poll, Spring 2007

JMRI Code: Building with Command Line Tools

Those of you who prefer a command line approach might want to investigate ant and maven, build utilities for Java projects. In the JMRI devlopment ecosystem, these two tools complement each other, each providing unique capabilities the other tool does not.

Ant

Ant is available for download at http://ant.apache.org/. Install it, then:

• Create a directory to contain your project.
• In that project directory, get the code from GitHub. This will create a jmri subdirectory where Ant will run, and load it with source, tests and resources. It will also create and populate directories for xml, libraries, etc. in the project directory.
• Change to the newly created jmri subdirectory. To compile, type ant debug.
• To run the program, type ant decoderpro or ant panelpro, and sit back to watch it go.
• To run the test suite, type ant alltest.
• To build a jmri.jar file, type ant dist. Note that you don't have to create the jmri.jar file to run the program.
• To erase all previously compiled results and force the program to be entirely built from scratch, type ant clean.

To make sure everything is working, before you e.g. commit your code back, please do:

ant clean alltest

and make sure the tests run cleanly.

A new JMRI checkout should build cleanly. If not, please check with the JMRIusers or jmri-developers mailings lists for help.

Maven

Maven is an extensible plugin-based build tool for Java development. Maven is available for download at http://maven.apache.org/. Maven will download the appropriate plugins and dependencies as needed. After installation, the following can be done from your JMRI working copy (see Getting the Code for instructions on creating a working copy):

Run unit and integration tests

mvn test
Use mvn test -Dtest=PATTERN to run specific tests. See Running a Single Test for more details, including running only a single test method.

Check for vulnerabilities in JMRI dependencies

mvn compile net.ossindex:ossindex-maven-plugin:audit

Check for newer versions of JMRI dependencies

mvn versions:display-dependency-updates

Check for newer versions of the maven plugins

mvn versions:display-plugin-updates

Run DecoderPro

mvn antrun:run -Danttarget=decoderpro

Run PanelPro

mvn antrun:run -Danttarget=panelpro

The scripts/mvn-test includes all the options necessary to run the Travis CI test Maven job from your local command line.

---