devel-proj-files.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 20 Jul 2011 12:31:56 +0300
changeset 900 7cdf5de5fdf7
parent 897 b4d7d3091494
child 907 5c1e6ce7ddac
permissions -rwxr-xr-x
Add toc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
900
7cdf5de5fdf7 Add toc
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 897
diff changeset
     1
.. contents::
897
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
Project sources.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
================
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
README file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
============
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     8
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
Assumed that users first read this file before start using project.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    10
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    11
 * Project name.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    12
 * Project goal.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    13
 * Point to license statements.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    14
 * Point to build instructions.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    15
 * Point to documentations.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    16
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    17
INSTALL file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    18
=============
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    19
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    20
 * List of supported platform.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    21
 * Build dependencies/prerequisites.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    22
 * Build instructions.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    23
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    24
COPYING/LICENSE file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    25
=====================
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    26
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    27
COPYING usually used for GNU GPL like license. Another license put in LICENSE
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    28
file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    29
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    30
If some component comes with different license put it into file with name like:
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    31
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    32
  LICENSE.libmy LICENSE.regex LICENSE.doc
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    33
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    34
AUTHORS file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    35
=============
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    36
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    37
Usually regular contributors.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    38
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    39
 * List of project members with contact info (email/phone/home page/address/etc).
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    40
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    41
THANKS/CREDITS file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    42
====================
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    43
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    44
Usually casual/non-regular contributors.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    45
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    46
 * List of contributors with contact info (email/phone/home page/address/etc).
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    48
NEWS/CHANGES/ANNOUNCE file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    49
===========================
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    50
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    51
Here goes news and descriptions of user visible changes:
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    52
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    53
 * Important project news.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    54
 * New features.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    55
 * Obsolescense/deprecation of UIs/APIs/protocols/formats.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    56
 * Incompatibilities with previous version.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    57
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    58
HISORY file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    59
============
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    60
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    61
 * Project history in long perspective.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    62
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    63
FAQ file.
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    64
=========
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    65
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    66
 * List of frequency asked questions with answers.