22 * ``.md`` - Markdown |
27 * ``.md`` - Markdown |
23 * ``.rd``, ``.rdoc`` - RDtool |
28 * ``.rd``, ``.rdoc`` - RDtool |
24 |
29 |
25 and optionally compressed - ``.gz``. |
30 and optionally compressed - ``.gz``. |
26 |
31 |
27 General info files. |
32 README file. |
|
33 ============ |
|
34 |
|
35 Assumed that users first read this file before start using project. |
|
36 |
|
37 * Project name. |
|
38 * Project goal/purpose. |
|
39 * Point to license statements. |
|
40 * Point to build instructions. |
|
41 * Point to documentations. |
|
42 * Use README-xxx for specific topic. |
|
43 |
|
44 ABOUT/OVERVIEW/SUMMARY file. |
|
45 ============================ |
|
46 |
|
47 * About project. |
|
48 * Use ABOUT-xxx for specific topic. |
|
49 |
|
50 ABOUT-NLS file. |
|
51 =============== |
|
52 |
|
53 * Notes on the Free Translation Project. |
|
54 |
|
55 NOTES/NOTICE file. |
|
56 ================== |
|
57 |
|
58 FEATURES file. |
|
59 ============== |
|
60 |
|
61 MIRRORS/WHERE file. |
28 =================== |
62 =================== |
29 |
63 |
30 README file. |
64 * Where get src/build, mirrors list. |
31 ------------ |
|
32 |
|
33 * README file should refer to the file INSTALL and copying conditions. |
|
34 * Use README-xxx for specific topic. |
|
35 |
|
36 ABOUT/OVERVIEW/SUMMARY file. |
|
37 ---------------------------- |
|
38 |
|
39 ABOUT-NLS file. |
|
40 --------------- |
|
41 |
|
42 * Notes on the Free Translation Project. |
|
43 |
|
44 NOTES/NOTICE file. |
|
45 ------------------ |
|
46 |
|
47 FEATURES file. |
|
48 -------------- |
|
49 |
|
50 FEEDBACK file. |
|
51 -------------- |
|
52 |
65 |
53 PLATFORMS file. |
66 PLATFORMS file. |
54 --------------- |
67 =============== |
55 |
68 |
56 * Supported platforms and compilers. |
69 * Supported platforms and compilers. |
57 |
70 |
58 PROBLEMS/KNOWNBUG/WARNINGS file. |
|
59 -------------------------------- |
|
60 :: |
|
61 |
|
62 PROBLEMS |
|
63 KNOWNBUG KNOWN_BUGS KNOWN-BUGS |
|
64 WARNINGS |
|
65 |
|
66 FORK file. |
|
67 ---------- |
|
68 |
|
69 * Why this project is fork of another project. |
|
70 |
|
71 COMMANDS file. |
|
72 -------------- |
|
73 |
|
74 * brief list of commands for built-in language |
|
75 |
|
76 PROGLIST file. |
|
77 -------------- |
|
78 |
|
79 UPGRADE/UPGRADING/CONVERSION file. |
|
80 ---------------------------------- |
|
81 |
|
82 * How upgrade to new version. |
|
83 |
|
84 MIRRORS/WHERE file. |
|
85 ------------------- |
|
86 |
|
87 * Where get src/build, mirrors list. |
|
88 |
|
89 SERVICE/SUPPORT file. |
|
90 --------------------- |
|
91 |
|
92 * about support services for software |
|
93 |
|
94 Thanks files. |
|
95 ============= |
|
96 :: |
|
97 |
|
98 ACKNOWLEDGEMENTS |
|
99 |
|
100 AUTHORS/THANKS files. |
|
101 ===================== |
|
102 |
|
103 AUTHORS/MAINTAINERS file. |
71 AUTHORS/MAINTAINERS file. |
104 ------------------------- |
72 ========================= |
105 :: |
73 :: |
106 |
74 |
107 AUTHOR AUTHORS MAINTAINERS |
75 AUTHOR AUTHORS MAINTAINERS |
108 |
76 |
|
77 * Was maintained for legal reasons. |
109 * Regular contributor list. |
78 * Regular contributor list. |
110 * List of project members with contact info (email, phone, home page, address, |
79 * List of project members with contact info (email, phone, home page, address, |
111 etc). |
80 etc). |
112 |
81 |
113 CONTRIBUTORS/THANKS/CREDITS file. |
82 CONTRIBUTORS/THANKS/CREDITS file. |
114 --------------------------------- |
83 ================================= |
115 :: |
84 :: |
116 |
85 |
117 CONTRIBUTORS THANKS CREDITS ACKNOWLEDGEMENTS |
86 CONTRIBUTORS THANKS CREDITS ACKNOWLEDGEMENTS |
118 |
87 |
119 * Casual/non-regular contributor list. |
88 * Casual/non-regular contributor list. |
|
89 * Wasn't maintained for legal reasons. |
120 * Thanks for hardware/hosting/money etc. |
90 * Thanks for hardware/hosting/money etc. |
121 |
91 |
122 DEDICATION file. |
92 DEDICATION file. |
123 ---------------- |
93 ================ |
124 |
94 |
125 README file. |
95 FEEDBACK file. |
126 ============ |
96 ============== |
127 |
97 |
128 Assumed that users first read this file before start using project. |
98 FORK file. |
129 |
99 ========== |
130 * Project name. |
100 |
131 * Project goal. |
101 * Why this project is fork of another project. |
132 * Point to license statements. |
102 |
133 * Point to build instructions. |
103 COMMANDS file. |
134 * Point to documentations. |
104 ============== |
135 |
105 |
136 ABOUT file. |
106 * brief list of commands for built-in language |
137 =========== |
107 |
138 |
108 PROGLIST file. |
139 * About project. |
109 ============== |
140 * In form of 'ABOUT-xxx' - about topic 'xxx'. |
110 |
141 |
111 UPGRADE/UPGRADING/CONVERSION file. |
142 Build/install instruction. |
112 ================================== |
143 ========================== |
113 |
144 |
114 * How upgrade to new version. |
145 INSTALL file. |
115 |
146 ------------- |
116 SERVICE/SUPPORT file. |
|
117 ===================== |
|
118 |
|
119 * about support services for software |
|
120 |
|
121 INSTALL/BUILD file. |
|
122 =================== |
147 |
123 |
148 * List of supported platform. |
124 * List of supported platform. |
149 * Build dependencies/prerequisites. |
125 * Build dependencies/prerequisites. |
150 * Build/installation instructions. |
126 * Build/installation instructions. |
151 |
127 |
152 BUILD file. |
|
153 ----------- |
|
154 |
|
155 CUSTOMIZE file. |
128 CUSTOMIZE file. |
156 --------------- |
129 =============== |
157 |
130 |
158 * Customize the compilation. |
131 * Customize the compilation. |
159 |
132 |
160 License files. |
133 License files. |
161 ============== |
134 ============== |