Skip to content

Commit

Permalink
Revised the readme to reflect changes brought on by Maven
Browse files Browse the repository at this point in the history
  • Loading branch information
anidev committed May 8, 2014
1 parent 5b1d8bc commit eac41a2
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ FRC Driver Station

Java implementation of the FRC driver station and communication protocol, initially in Java and later in other
languages. Java was chosen because it can be ported easily to other platforms, with Android being the next goal.
Each project can be compiled manually but no build scripts have been created yet. To build automatically, import the
projects as Eclipse projects or use the entire repository as an Eclipse Workspace.
The entire project uses the Maven build system for compiling and packaging. To build the entire project from
scratch and create the JAR files, run "mvn clean compile package" from the java/ subdirectory, or from an
individual project directory to compile and package just that project. Everything can also be imported into
Eclipse and compiled from there (with the m2eclipse plugin).

Currently, FRCDS-Java-Comm is the Java library for the communication protocol. It implements classes for encapsulating
data that can be sent from the driver station to the robot (FRCCommonControl), and data that can be sent from the
Expand All @@ -21,7 +23,11 @@ dedicated loop and performs such actions as incrementing the elapsed time counte
given frequency (default 50.0Hz).

FRC-DriverStation-PC is the driver station implementation for PC. It uses the classes in Common and builds a GUI
around it. The GUI is powered by Swing, currently using the Nimbus L&F. To compile, forms.jar (for FormLayout) and JNA libraries (jna.jar, platform.jar) must be in the build path.
around it. The GUI is powered by Swing, using the Nimbus L&F. It uses the JGoodies FormLayout for laying out certain
GUI components. FormLayout is included in this repository and is automatically used by Maven when building.

FRC-Netconsole-PC contains the GUI-related classes for Netconsole. It generates the standalone netconsole JAR file, and
is used by FRC-DriverStation-PC to provide an embedded Netconsole panel.

FRC-DriverStation-Android is the driver station implementation for Android. It also uses the classes in Common and builds
an Android app around it. The app is targeted for 4.1.2 Jellybean (API 16) and has compliance down to 2.3.3 Gingerbread
Expand Down

0 comments on commit eac41a2

Please sign in to comment.