This page includes the coding guidelines we try to follow through the Translate project.
For any given project, proj, we use the following files and directories (under the main project directory) for the given purposes:
proj/ - The sub-directory with the same name as the project, containing the program's source tree. The directory structure below this level depends on the project.
devsupport/ - This is where any source files should go that are used during development or optional at runtime. Profiling and specific utility code should go here.
share/proj/- Any resource files that should be installed (typically in
/usr/share/proj/on *nix), but are not source files. For example GUI files, icons, data files.
run_proj.py- The main execution script. (This will likely change in the future)
setup.py- Build- and installation script for the project using the
distutilspackage and optionally InnoSetup.
Notes on this proposed layout: