ICub software: Difference between revisions
(→Getting an SVN client: change section title to "Preliminaries"; install cmake) |
(→Downloading iCub as a single file: how to download iCub repository snapshots) |
||
| Line 71: | Line 71: | ||
svn update | svn update | ||
=== Downloading iCub | === Downloading iCub snapshot files === | ||
Periodic snapshots of the iCub repository are available here: | |||
http://eris.liralab.it/iCub/downloads/src/ | |||
Note that there are three types of files: | |||
* iCub-src-x.y.z.tar.gz: the whole iCub repository, version x.y.z | |||
* YARP4iCub-src-x.y.z.tar.gz: a snapshot of the YARP repository at the time when iCub x.y.z is taken. | |||
* iCub-dep-x.y.z.txt: a list of the libraries that are required to compile the code in snapshot x.y.z. | |||
== Compiling the repositories == | == Compiling the repositories == | ||
Revision as of 12:01, 13 November 2009
Effective August 2009, YARP and iCub software repositories have been moved to SourceForge.net servers and must be downloaded with Subversion (SVN).
It is recommended that you rename your old (CVS) iCub and yarp2 directories and do a fresh download of the new SVN repositories.
Preliminaries
You should install an SVN client on your system if you do not have one already. For Windows, TortoiseSVN is recommended. If you run Linux or other UNIX flavours, chances are high that you can just go ahead using svn in command line (if that is not the case, install it with apt-get install subversion or equivalent).
Furthermore, you should install CMake.
YARP
Browsing the yarp2 repository online
http://yarp0.svn.sf.net/viewvc/yarp0/trunk/yarp2/
Getting the yarp2 repository in Windows
Inside TortoiseSVN, use the file manager to browse to the location where you would like to download the code. Right click on an empty region of the window and select "SVN checkout" from the contextual menu.
Type the following string in the entry "URL of repository":
https://yarp0.svn.sourceforge.net/svnroot/yarp0/trunk/yarp2
No password or username will be required.
Note: if you use Cygwin, refer to Linux instructions instead.
Getting the yarp2 repository in Linux
Paste the following command in a console terminal:
svn co https://yarp0.svn.sourceforge.net/svnroot/yarp0/trunk/yarp2
This will create a new directory called yarp2 that contains the software. Your environment variables YARP_DIR and YARP_ROOT should be set to that directory (e.g., /home/yourname/yarp2).
Updating the yarp2 repository in Linux
cd $YARP_ROOT svn update
Downloading YARP as a single file
If for whatever reason you cannot use SVN on a machine, or you do not want the very latest revision of the repository, you may just download a single file containing YARP here: [1]. Pre-compiled binaries are also available.
iCub
Browsing the iCub repository online
http://robotcub.svn.sf.net/viewvc/robotcub/trunk/iCub/
Getting the iCub repository in Windows
Inside TortoiseSVN, use the file manager to browse to the location where you would like to download the code. Right click on an empty region of the window and select "SVN checkout" from the contextual menu.
Type the following string in the entry "URL of repository":
https://robotcub.svn.sourceforge.net/svnroot/robotcub/trunk/iCub
No password or username will be required.
Note: if you use Cygwin, refer to Linux instructions instead.
Getting the iCub repository in Linux
Paste the following command in a console terminal:
svn co https://robotcub.svn.sourceforge.net/svnroot/robotcub/trunk/iCub
This will create a new directory called iCub that contains the software. Your environment variables ICUB_DIR and ICUB_ROOT should be set to that directory (e.g., /home/yourname/iCub).
Updating the iCub repository in Linux
cd $ICUB_ROOT svn update
Downloading iCub snapshot files
Periodic snapshots of the iCub repository are available here: http://eris.liralab.it/iCub/downloads/src/
Note that there are three types of files:
- iCub-src-x.y.z.tar.gz: the whole iCub repository, version x.y.z
- YARP4iCub-src-x.y.z.tar.gz: a snapshot of the YARP repository at the time when iCub x.y.z is taken.
- iCub-dep-x.y.z.txt: a list of the libraries that are required to compile the code in snapshot x.y.z.
Compiling the repositories
To compile the yarp2 (respectively, iCub) repository, go to YARP_DIR (respectively, ICUB_DIR) and generate the project files with the CMake program. In Linux you do this with the command
ccmake .
and you obtain a Makefile, while in Windows you do it with the CMake GUI and you obtain Microsoft Visual Studio solution files (sln extension).
Having generated your project file, only the actual compilation remains to be done. In Linux type make, in Windows build the VS solution.
Committing changes to the repositories
If you are a developer and you need to add/modify files within the repository, you need two things:
- a SourceForge.net account; once you have that, send an email to the RobotCub project administrators to join the project
- make sure that your SVN client is configured correctly with regard to auto-props, which is a mechanism that takes care of line endings and MIME filetypes according to wildcards (for example, setting some flags for *.txt files and other flags for *.sh). Go here for a better explanation, and check the 'Subversion client flags' page (linked below) for auto-props adopted by RobotCub developers.