simulation/README.md

## Components and Location

Simluation is a mix of wpilib and other components.
The wpilib components are in their respective locations in the /wpilibc and /wpilibj directories.

The gazbeo plugins are currently built with CMake.
Eventually they will be built with gradle.

## Simulation delivery and installation

For 2016 FRCSim is only officially supported on Ubuntu 14.04 or greater.
However it is possible on any platform that runs Gazebo.
FRCSim is currently delivered via a zip file published by this project,
and is available at first.wpi.edu/FRC/roborio/maven/PROMOTION_STATUS/edu/wpi/first/wpilib/simulation/simulation/1.0.0/simulation-1.0.0.zip
where PROMOTION_STATUS is one of:
- development (the latest commit merged into wpilib)
- beta (used periodically before release)
- release (used just before kick-off and possibly a few other times)
- stable (used for old releases we want to keep around)

The zip contains most of the contents of ~/wpilib/simulation, such as C++ libraries, jars, and scripts

The exmple robot model files are seperate, and can be found under "file releases" on collabnet.

All together you need eclipse, gazebo, those two zips, g++ 4.9, java8, and a few other small packages.
See the frcsim-installer script or the screensteps on manual install for all the nitty-gritty details

The frcsim-installer script is meant for quick and painless setup on Ubuntu 14.04, 15.04, or 15.10
A manual install is a more tedious process, so this is an easy option for students.

## Building
See the top level README.md.
Fixing the frcsim installer script URL for simulation zip changed as of gerrit 1264 script argument name changed from INSTALLER to INSTALL fixed jar and logo paths for sim_ds to use the script, it's now simply: ./frcsim-installer.sh INSTALL You can optionally supply a promotion status from which to install, such as ./frcsim-installer.sh INSTALL beta ./frcsim-installer.sh INSTALL development Also added some information to the README Also allow any type of file install-resources since it may contain libraries and jars Change-Id: Ie876a05c88d3d48b8592f1800959988ae66edd04 2015-12-29 19:16:52 -05:00			`## Components and Location`

			`Simluation is a mix of wpilib and other components.`
			`The wpilib components are in their respective locations in the /wpilibc and /wpilibj directories.`
merged from frcsim branch verified to work on real robots adds sim eclipse plugins, fixed JavaGazebo, made wpilibC++Sim build on windows - Java and C++ simulation robot programs run on windows - simulation eclipse plugin delivers models and gazebo plugins - Java Gazebo now respects GAZEBO_IP variables and can work across networks - hal and network tables win32 hacked to work on windows - smart dashboard broken on windows due to network tables hacks - wpilibC++Sim, gz_msgs, and frcsim_gazebo_plugins build with CMake - removed constexpr for cross platform compatibility - msgs generated using .protos as a part of build process - some spare and unused cmake/pom files deleted - simulation ubuntu debians removed entirely - refactored CMake project flags and macros - updated to match non-sim C++ API - fixed and updated documentation - servo added to simulation Change-Id: Ia702ff0f1fee10d77f543810ad88f56696443b05 2015-04-26 19:19:57 -04:00
			`The gazbeo plugins are currently built with CMake.`
			`Eventually they will be built with gradle.`

Fixing the frcsim installer script URL for simulation zip changed as of gerrit 1264 script argument name changed from INSTALLER to INSTALL fixed jar and logo paths for sim_ds to use the script, it's now simply: ./frcsim-installer.sh INSTALL You can optionally supply a promotion status from which to install, such as ./frcsim-installer.sh INSTALL beta ./frcsim-installer.sh INSTALL development Also added some information to the README Also allow any type of file install-resources since it may contain libraries and jars Change-Id: Ie876a05c88d3d48b8592f1800959988ae66edd04 2015-12-29 19:16:52 -05:00			`## Simulation delivery and installation`

			`For 2016 FRCSim is only officially supported on Ubuntu 14.04 or greater.`
			`However it is possible on any platform that runs Gazebo.`
			`FRCSim is currently delivered via a zip file published by this project,`
			`and is available at first.wpi.edu/FRC/roborio/maven/PROMOTION_STATUS/edu/wpi/first/wpilib/simulation/simulation/1.0.0/simulation-1.0.0.zip`
			`where PROMOTION_STATUS is one of:`
			`- development (the latest commit merged into wpilib)`
			`- beta (used periodically before release)`
			`- release (used just before kick-off and possibly a few other times)`
			`- stable (used for old releases we want to keep around)`

			`The zip contains most of the contents of ~/wpilib/simulation, such as C++ libraries, jars, and scripts`

			`The exmple robot model files are seperate, and can be found under "file releases" on collabnet.`

			`All together you need eclipse, gazebo, those two zips, g++ 4.9, java8, and a few other small packages.`
			`See the frcsim-installer script or the screensteps on manual install for all the nitty-gritty details`

			`The frcsim-installer script is meant for quick and painless setup on Ubuntu 14.04, 15.04, or 15.10`
			`A manual install is a more tedious process, so this is an easy option for students.`
merged from frcsim branch verified to work on real robots adds sim eclipse plugins, fixed JavaGazebo, made wpilibC++Sim build on windows - Java and C++ simulation robot programs run on windows - simulation eclipse plugin delivers models and gazebo plugins - Java Gazebo now respects GAZEBO_IP variables and can work across networks - hal and network tables win32 hacked to work on windows - smart dashboard broken on windows due to network tables hacks - wpilibC++Sim, gz_msgs, and frcsim_gazebo_plugins build with CMake - removed constexpr for cross platform compatibility - msgs generated using .protos as a part of build process - some spare and unused cmake/pom files deleted - simulation ubuntu debians removed entirely - refactored CMake project flags and macros - updated to match non-sim C++ API - fixed and updated documentation - servo added to simulation Change-Id: Ia702ff0f1fee10d77f543810ad88f56696443b05 2015-04-26 19:19:57 -04:00
			`## Building`
Fixed some typos in the comments of MotorEncoderFixture.java, a method name in CANMotorEncoderFixture.java, and the README files Change-Id: I87d982068f3e7cdcce6e5b06c34a7ef326f5eae0 2015-11-23 00:35:34 -08:00			`See the top level README.md.`