Modules - Folder Structure

From Asibot & HOAP3 & TEO Wiki
Revision as of 18:39, 15 April 2010 by Jgvictores (talk | contribs)
Jump to navigation Jump to search

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-like operating systems, a project-generating script may be used [1].


  • 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:

  • 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... ('data' in earlier modules).
  • out/win32/, out/linux-x86/, etc, must also contain the platform-specific shared libraries and other complements necesary for the execution of the resulting application or library.