Guidelines
From WikIRI
Contents |
Software Development Guidelines
This page describes the Software Development Guidelines for the Robotics group. It is mainly focussed in the development under Linux.
The objective is to uniformize the source generated at the Robotics groups to make it easy for all members of the group to understand the structure of our software projects.
Structure
All software projects should be their own directory with the following sub-directories:
- src: With the cpp (source) files .
- include: With the h (header) files.
- doc: With the documentation.
Morover, you sould add the following files:
- ReadMe.txt: Describing you project (resulting executables, how to use them, format of the input data, format of the outputs, etc.).
- CMakeLists.txt: With the cmake configuration for your project.
Tools
Basic tools to use
- C++: To compile your sources.
- Cmake: To automatically generate makefiles and/or project files.
- Doxygen: To document you code.
- cvs: To backup and to keep track of the different stages in the development and to share the code with the rest of the group. See Access to the software/papers repositories.
Optionally, you can use
- ddd: To debug you programs.
- Valgrind: To debug the use of memory in your programs.
- Kdevelop: The KDE development environment.
TODO
- Complete this page with a downloadable "Hello World" example including the IRI-Robotics css for doxygen.
- Define a programming style.
- Replace cvs with subversion.
- Decide with basic libraries to use: mathematical libraries (gls?), interfaces (qt?). ....
