Developer References.md

References

Online documentation and releases: http://winder.github.io/ugs_website/
Discussion forum: https://groups.google.com/forum/#!forum/universal-gcode-sender

Development

For development the Maven build tool is used.

Start the application

UGS Classic:

mvn install
mvn exec:java -Dexec.mainClass="com.willwinder.universalgcodesender.MainWindow" -pl ugs-core

UGS Platform:

mvn install
mvn nbm:run-platform -pl ugs-platform/application

Execute all tests

mvn test

Building the self-executing JAR

mvn install
mvn package -pl ugs-core

Build a UniversalGcodeSender.zip release file

mvn package assembly:assembly

Develop via IntelliJ

If you are more used to IntelliJ, you can also build, run and debug it there.

Before you start you need to change a setting for handling imports in Maven since we are using jgitver, read more about it here.

• Run mvn nbm:run-platform -pl ugs-platform/application once via terminal to build everything
• Import the Source, File -> New -> Project from existing Sources
• Setup a new "Run Configuration", Java Application, with following settings:
  • Main Class: org.netbeans.Main
  • VM Options: -Dnetbeans.user=$ProjectFileDir$/ugs-platform/application/target/userdir -Dnetbeans.home=$ProjectFileDir$/ugs-platform/application/target/ugsplatform/platform -Dnetbeans.logger.console=true -Dnetbeans.indexing.noFileRefresh=true -Dnetbeans.dirs="$ProjectFileDir$/ugs-platform/application/target/ugsplatform/ugsplatform:$ProjectFileDir$/ugs-platform/application/target/ugsplatform/platform:$ProjectFileDir$/ugs-platform/application/target/ugsplatform/ide:$ProjectFileDir$/ugs-platform/application/target/ugsplatform/extra:$ProjectFileDir$/ugs-platform/application/target/ugsplatform/java"
  • Program arguments: --branding ugsplatform
  • Working dir: $ProjectFileDir$
  • Use classpath of module: ugs-platform-app
• There is a runConfiguration in the repository, which should be available after importing the project