From 1103c95f5b9f263237aa12c268c3168084ff9df9 Mon Sep 17 00:00:00 2001 From: Carlo Pinciroli Date: Thu, 17 Jan 2013 14:32:51 +0100 Subject: [PATCH] Added a little README in the source directory to explain what each directory contains. --- src/README.asciidoc | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 src/README.asciidoc diff --git a/src/README.asciidoc b/src/README.asciidoc new file mode 100644 index 00000000..e7f16453 --- /dev/null +++ b/src/README.asciidoc @@ -0,0 +1,15 @@ +ARGoS SOURCE DIRECTORY STRUCTURE +================================ +:Author: Carlo Pinciroli +:Email: ilpincy@gmail.com +:Date: January 17th, 2013 + +The ARGoS sources are organized in a set of directories, following this schema: + +* +src/argos3+: a soft link to the +src/+ directory. When ARGoS is installed in the system, +#include+ statements will look into the +argos3/+ directory. This soft link is necessary to +#include+ the files correctly when compiling the source. +* +src/cmake/+: contains all the custom CMake modules and scripts necessary to compile ARGoS +* +src/core/+: contains all the core ARGoS code, which makes up the executable and the main dynamic library +* +src/plugins/+: contains non-core but necessary parts of ARGoS, such as physics engines, visualizations, robots, etc. provided by default +* +src/scripts/+: contains a set of scripts to perform various tasks (installation, modification of code, etc.) +* +src/testing/+: contains a set of test files of various kinds +* +src/wrappers/+: contains the code necessary to wrap ARGoS with other languages and systems (ex. Lua, ROS, etc.)