Difference between revisions of "Modules - Folder Structure"

From Asibot & HOAP3 & TEO Wiki
Jump to navigation Jump to search
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.
 
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.
 
+
----
 
* doc/
 
* doc/
 
* extern/
 
* extern/
Line 25: Line 25:
 
* INSTALL
 
* INSTALL
 
* install-win32.txt
 
* install-win32.txt
 
+
----
Notes:
+
<U>Notes</U>:
 
* A project generating shell script has been developed for this purpose.
 
* A project generating shell script has been developed for this purpose.
 
** svn co ((your_code_repo))/trunk/tools/mkproy
 
** svn co ((your_code_repo))/trunk/tools/mkproy

Revision as of 19:28, 8 March 2010

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.


  • doc/
  • extern/
    • bin/
      • linux-x86/
      • win32/
      • ...
    • include/
    • lib/
      • linux-x86/
      • win32/
      • ...
  • mk/
    • msvc9/
    • linux-x86/
    • ...
  • out/
    • share/
    • win32/
    • linux-x86/
    • ...
  • src/
  • AUTHORS
  • INSTALL
  • install-win32.txt

Notes:

  • A project generating shell script has been developed for this purpose.
    • svn co ((your_code_repo))/trunk/tools/mkproy
  • extern/ is intended for 3rd party libraries.
  • 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.