forked from ilpincy/argos3
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a little README in the source directory to explain what each di…
…rectory contains.
- Loading branch information
Showing
1 changed file
with
15 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
ARGoS SOURCE DIRECTORY STRUCTURE | ||
================================ | ||
:Author: Carlo Pinciroli | ||
:Email: [email protected] | ||
: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.) |