Modules - Folder Structure

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.

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