Difference between revisions of "Modules - Folder Structure"

From Asibot & HOAP3 & TEO Wiki
Jump to navigation Jump to search
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
The intention of defining this folder structure should be for each project to be self-contained. Full implementation is not necessary. This folder stucture is designed for compiled (''c++''-style) projects. For advise on naming modules, check [[Modules - Naming Modules and Variables]] page. For UNIX-style operating systems, a project-generating script may be used.
+
Applicable to [[Modules - Guidelines v0.3|Robot Component Guidelines v0.3]]. Full implementation is not necessary, as this folder stucture is designed for compiled (''c++''-style) projects. For advise on naming modules, check [[Modules - Naming Modules and Variables]] page. For UNIX-like operating systems, a [[Project-generating script]] has been developed. <!-- [http://roborepo.uc3m.es/svn/ASIBOTcoderepo/trunk/tools/mkproy].-->
  
 +
----
 
* doc/
 
* doc/
* extern/
 
** bin/
 
*** linux-x86/
 
*** win32/
 
*** ...
 
** include/
 
** lib/
 
*** linux-x86/
 
*** win32/
 
*** ...
 
* mk/
 
** msvc9/
 
** linux-x86/
 
** ...
 
 
* out/
 
* out/
 
** share/
 
** share/
Line 23: Line 10:
 
* src/
 
* src/
 
* AUTHORS
 
* AUTHORS
 +
* CMakeLists.txt
 
* INSTALL
 
* INSTALL
* install-win32.txt
 
  
Notes:
+
----
* A project generating shell script has been developed for this purpose.
+
 
** svn co ((your_code_repo))/trunk/tools/mkproy
+
<U>Notes:</U>
* extern/ is intended for 3rd party libraries.
+
* ''share'' is intended for inclusion of multiplatform data for execution of the program, such as .mp3 sounds, etc...
* share/ is intended for inclusion of multiplatform data for execution of the program, such as 3d models, etc... (was called 'data' in an earlier version of the standard).
 
* out/win32/, out/linux-x86, etc, must contain the platform-specific shared libraries and other complements necesary for the execution of the resulting application or library.
 

Latest revision as of 08:45, 20 October 2010

Applicable to Robot Component Guidelines v0.3. Full implementation is not necessary, as this folder stucture is designed for compiled (c++-style) projects. For advise on naming modules, check Modules - Naming Modules and Variables page. For UNIX-like operating systems, a Project-generating script has been developed.


  • doc/
  • out/
    • share/
    • win32/
    • linux-x86/
    • ...
  • src/
  • AUTHORS
  • CMakeLists.txt
  • INSTALL

Notes:

  • share is intended for inclusion of multiplatform data for execution of the program, such as .mp3 sounds, etc...