devel-proj-hierarchy.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Mon, 22 Feb 2016 12:41:52 +0200
changeset 1903 901e7394849f
parent 1457 3a90e314bb47
child 1905 fba288d59662
permissions -rw-r--r--
Decrease intent to increase space usage on mobile.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1456
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     1
.. -*- coding: utf-8; -*-
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
.. include:: HEADER.rst
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
=============================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
 Software project hierarchy.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
=============================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
.. contents::
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     8
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
Additional reading.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    10
===================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    11
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    12
 * http://stackoverflow.com/questions/14747056/common-practice-to-name-project-directory-which-hold-support-scripts-configs-d
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    13
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    14
Essential project dirs.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    15
=======================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    16
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    17
TODO
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    18
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    19
Support directories.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    20
====================
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    21
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    22
``examples`` or ``samples`` used to show practical usage of project in
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    23
mini-scripts or mini-programs, or mini-configs.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    24
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    25
``scripts``, ``support`` - wrappers or copy of missing scripts/utilities to
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    26
provide cross-environment build.
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    27
1457
3a90e314bb47 'contrib' dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1456
diff changeset
    28
``tools`` - extra utilities to profile or debug project.
3a90e314bb47 'contrib' dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1456
diff changeset
    29
3a90e314bb47 'contrib' dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1456
diff changeset
    30
``contrib`` - user supplied scripts, configs, etc...
1456
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    31
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    32
``misc``, ``etc`` - uncategorised files (if you don't know the right place for
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    33
it).
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    34
1457
3a90e314bb47 'contrib' dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1456
diff changeset
    35
``config``, ``extra``
1456
c10ad97c2cb8 Support directories.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    36