1 

     2 Project sources.

     3 ================

     4 

     5 README file.

     6 ============

     7 

     8 Assumed that users first read this file before start using project.

     9 

    10  * Project name.

    11  * Project goal.

    12  * Point to license statements.

    13  * Point to build instructions.

    14  * Point to documentations.

    15 

    16 INSTALL file.

    17 =============

    18 

    19  * List of supported platform.

    20  * Build dependencies/prerequisites.

    21  * Build instructions.

    22 

    23 COPYING/LICENSE file.

    24 =====================

    25 

    26 COPYING usually used for GNU GPL like license. Another license put in LICENSE

    27 file.

    28 

    29 If some component comes with different license put it into file with name like:

    30 

    31   LICENSE.libmy LICENSE.regex LICENSE.doc

    32 

    33 AUTHORS file.

    34 =============

    35 

    36 Usually regular contributors.

    37 

    38  * List of project members with contact info (email/phone/home page/address/etc).

    39 

    40 THANKS/CREDITS file.

    41 ====================

    42 

    43 Usually casual/non-regular contributors.

    44 

    45  * List of contributors with contact info (email/phone/home page/address/etc).

    46 

    47 NEWS/CHANGES/ANNOUNCE file.

    48 ===========================

    49 

    50 Here goes news and descriptions of user visible changes:

    51 

    52  * Important project news.

    53  * New features.

    54  * Obsolescense/deprecation of UIs/APIs/protocols/formats.

    55  * Incompatibilities with previous version.

    56 

    57 HISORY file.

    58 ============

    59 

    60  * Project history in long perspective.

    61 

    62 FAQ file.

    63 =========

    64 

    65  * List of frequency asked questions with answers.