|
1456
|
1 |
.. -*- coding: utf-8; -*-
|
|
|
2 |
.. include:: HEADER.rst
|
|
|
3 |
|
|
|
4 |
=============================
|
|
|
5 |
Software project hierarchy.
|
|
|
6 |
=============================
|
|
|
7 |
.. contents::
|
|
|
8 |
|
|
|
9 |
Additional reading.
|
|
|
10 |
===================
|
|
|
11 |
|
|
|
12 |
* http://stackoverflow.com/questions/14747056/common-practice-to-name-project-directory-which-hold-support-scripts-configs-d
|
|
|
13 |
|
|
|
14 |
Essential project dirs.
|
|
|
15 |
=======================
|
|
|
16 |
|
|
|
17 |
TODO
|
|
|
18 |
|
|
|
19 |
Support directories.
|
|
|
20 |
====================
|
|
|
21 |
|
|
|
22 |
``examples`` or ``samples`` used to show practical usage of project in
|
|
|
23 |
mini-scripts or mini-programs, or mini-configs.
|
|
|
24 |
|
|
|
25 |
``scripts``, ``support`` - wrappers or copy of missing scripts/utilities to
|
|
|
26 |
provide cross-environment build.
|
|
|
27 |
|
|
1457
|
28 |
``tools`` - extra utilities to profile or debug project.
|
|
|
29 |
|
|
|
30 |
``contrib`` - user supplied scripts, configs, etc...
|
|
1456
|
31 |
|
|
|
32 |
``misc``, ``etc`` - uncategorised files (if you don't know the right place for
|
|
|
33 |
it).
|
|
|
34 |
|
|
1457
|
35 |
``config``, ``extra``
|
|
1456
|
36 |
|