RoboCup Compile HOWTO
From GT RoboJackets
Contents |
System Requirements
The target system for RoboCup is (K)Ubuntu 11.04. These instructions have been tested on a clean, updated install. We have also verified earlier versions of (K)Ubuntu with 10.04 and 10.10, though typically stick with the latest release.
Getting the source
sudo apt-get install git-core mkdir robocup cd robocup git clone ssh://<username>@robojackets.org/git/robocup/software cd software
Installing packages
If you haven't built the code before, you may need to install several packages. There is a script to do this automatically on Ubuntu:
./util/ubuntu-setup
You will need to enter your password for sudo. To add more dependencies, modify this script rather than adding new instructions to the wiki, as this will ensure that it is always possible to keep the build scripts up to date.
Building
scons
If it ends without errors, you now have all the executables (and links to their default configuration) in run/.
For convenience while running programs, you can stay in the run directory and build from there:
scons -u
scons will search parent directories for SConstruct and start building from that point.
Documentation
To auto-generate documentation for the system, in the root software folder, run
doxygen
which will create a folder called api_docs with documentation.
Cleaning
Just delete the build/ directory to remove all build products. To clean a particular part of the project, do something like:
scons -c soccer
Build System
scons is a build tool based on Python. All our software is now built as a single scons project. The site_scons directory contains third-party tools used by the scons scripts. The scons User Manual is a good place to start.
