37 * Doc (documentation). |
37 * Doc (documentation). |
38 * VCS (version control system). |
38 * VCS (version control system). |
39 * BTS (bug tracking). |
39 * BTS (bug tracking). |
40 * News (project news/history/changelog). |
40 * News (project news/history/changelog). |
41 |
41 |
42 * Project sources. |
42 * Docs. |
43 |
43 |
44 ** README file. |
44 TODO |
45 |
|
46 Assumed that users first read this file before start using project. |
|
47 |
|
48 * Project name. |
|
49 * Project goal. |
|
50 * Point to license statements. |
|
51 * Point to build instructions. |
|
52 * Point to documentations. |
|
53 |
|
54 ** INSTALL file. |
|
55 |
|
56 * List of supported platform. |
|
57 * Build dependencies/prerequisites. |
|
58 * Build instructions. |
|
59 |
|
60 ** COPYING/LICENSE file. |
|
61 |
|
62 COPYING usually used for GNU GPL like license. Another license put in LICENSE |
|
63 file. |
|
64 |
|
65 If some component comes with different license put it into file with name like: |
|
66 |
|
67 LICENSE.libmy LICENSE.regex LICENSE.doc |
|
68 |
|
69 ** AUTHORS file. |
|
70 |
|
71 Usually regular contributors. |
|
72 |
|
73 * List of project members with contact info (email/phone/home page/address/etc). |
|
74 |
|
75 ** THANKS/CREDITS file. |
|
76 |
|
77 Usually casual/non-regular contributors. |
|
78 |
|
79 * List of contributors with contact info (email/phone/home page/address/etc). |
|
80 |
|
81 ** NEWS/CHANGES/ANNOUNCE file. |
|
82 |
|
83 Here goes news and descriptions of user visible changes: |
|
84 |
|
85 * Important project news. |
|
86 * New features. |
|
87 * Obsolescense/deprecation of UIs/APIs/protocols/formats. |
|
88 * Incompatibilities with previous version. |
|
89 |
|
90 ** HISORY file. |
|
91 |
|
92 * Project history in long perspective. |
|
93 |
|
94 ** FAQ file. |
|
95 |
|
96 * List of frequency asked questions with answers. |
|
97 |
|
98 * Docs. |
|
99 |
45 |
100 * Project home page. |
46 * Project home page. |
101 |
47 |
102 Project home page must provide: |
48 Project home page must provide: |
103 |
49 |