devel-proj-files.rst
changeset 907 5c1e6ce7ddac
parent 900 7cdf5de5fdf7
child 908 660c0dac57c2
equal deleted inserted replaced
906:0066b8634d2e 907:5c1e6ce7ddac
     1 .. contents::
     1 .. contents::
     2 
     2 
     3 Project sources.
     3 Essential project files.
     4 ================
     4 ========================
       
     5 
       
     6  * README
       
     7  * INSTALL
       
     8  * 
       
     9 
       
    10 General info files.
       
    11 ===================
       
    12 
       
    13 README file.
       
    14 ------------
       
    15 
       
    16 ABOUT/OVERVIEW file.
       
    17 --------------------
       
    18 
       
    19 ABOUT-NLS file.
       
    20 ---------------
       
    21 
       
    22  * Notes on the Free Translation Project.
       
    23 
       
    24 NOTES/NOTICE file.
       
    25 ------------------
       
    26 
       
    27 FEATURES file.
       
    28 --------------
       
    29 
       
    30 FEEDBACK file.
       
    31 --------------
       
    32 
       
    33 PLATFORMS file.
       
    34 ---------------
       
    35 
       
    36  * Supported platforms and compilers.
       
    37 
       
    38 PROBLEMS/KNOWNBUG file.
       
    39 -----------------------
       
    40 ::
       
    41 
       
    42   PROBLEMS  KNOWNBUG  KNOWN_BUGS  KNOWN-BUGS
       
    43 
       
    44 FORK file.
       
    45 ----------
       
    46 
       
    47  * Why this project is fork of another project.
       
    48 
       
    49 COMMANDS file.
       
    50 --------------
       
    51 
       
    52  * brief list of commands for built-in language
       
    53 
       
    54 PROGLIST file.
       
    55 --------------
       
    56 
       
    57 UPGRADE/UPGRADING/CONVERSION file.
       
    58 ----------------------------------
       
    59 
       
    60  * How upgrade to new version.
       
    61 
       
    62 MIRRORS file.
       
    63 -------------
       
    64 
       
    65 Thanks files.
       
    66 =============
       
    67 ::
       
    68 
       
    69   ACKNOWLEDGEMENTS
       
    70 
       
    71 Contributors files.
       
    72 ===================
       
    73 
       
    74 AUTHOR file.
       
    75 ------------
       
    76 ::
       
    77 
       
    78   authors
       
    79   AUTHOR
       
    80   AUTHORS
     5 
    81 
     6 README file.
    82 README file.
     7 ============
    83 ============
     8 
    84 
     9 Assumed that users first read this file before start using project.
    85 Assumed that users first read this file before start using project.
    12  * Project goal.
    88  * Project goal.
    13  * Point to license statements.
    89  * Point to license statements.
    14  * Point to build instructions.
    90  * Point to build instructions.
    15  * Point to documentations.
    91  * Point to documentations.
    16 
    92 
       
    93 ABOUT file.
       
    94 ===========
       
    95 
       
    96  * About project.
       
    97  * In form of 'ABOUT-xxx' - about topic 'xxx'.
       
    98 
       
    99 Build/install instruction.
       
   100 ==========================
       
   101 
    17 INSTALL file.
   102 INSTALL file.
    18 =============
   103 -------------
    19 
   104 
    20  * List of supported platform.
   105  * List of supported platform.
    21  * Build dependencies/prerequisites.
   106  * Build dependencies/prerequisites.
    22  * Build instructions.
   107  * Build instructions.
    23 
   108 
    24 COPYING/LICENSE file.
   109 BUILD file.
    25 =====================
   110 -----------
       
   111 
       
   112 CUSTOMIZE file.
       
   113 ---------------
       
   114 
       
   115  * Customize the compilation.
       
   116 
       
   117 License files.
       
   118 ==============
       
   119 
       
   120 DISCLAIMER file.
       
   121 ----------------
       
   122 
       
   123 PATENTS file.
       
   124 -------------
       
   125 
       
   126 COPYING/LICENSE/LEGAL file.
       
   127 ---------------------------
    26 
   128 
    27 COPYING usually used for GNU GPL like license. Another license put in LICENSE
   129 COPYING usually used for GNU GPL like license. Another license put in LICENSE
    28 file.
   130 file.
    29 
   131 
    30 If some component comes with different license put it into file with name like:
   132 If some component comes with different license put it into file with name like::
    31 
   133 
    32   LICENSE.libmy LICENSE.regex LICENSE.doc
   134   LICENSE.libmy LICENSE.regex LICENSE.doc
    33 
   135   COPYING-DOCS  COPYING-GPL   COPYING-LGPL  COPYING-LIBS  COPYING-TEMPLATES
    34 AUTHORS file.
   136 
    35 =============
   137 COPYRIGHT file.
    36 
   138 ---------------
    37 Usually regular contributors.
   139 ::
    38 
   140 
       
   141   copyright
       
   142   COPYRIGHT
       
   143   copyright-artwork
       
   144   copyright-notice
       
   145 
       
   146 AFL file.
       
   147 ---------
       
   148 
       
   149 Academic Free License.
       
   150 
       
   151   AFL-1.1
       
   152   AFL-1.2
       
   153   AFL-2.0
       
   154   AFL-2.1
       
   155 
       
   156  * http://www.opensource.org/licenses/afl-3.0.php
       
   157  * http://en.wikipedia.org/wiki/Academic_Free_License
       
   158 
       
   159 Apache file.
       
   160 ------------
       
   161 ::
       
   162 
       
   163   Apache-1.0
       
   164   Apache-1.1
       
   165   Apache-2.0
       
   166 
       
   167 PHP file.
       
   168 ---------
       
   169 ::
       
   170 
       
   171   PHP-3.0
       
   172 
       
   173 MIT file.
       
   174 ---------
       
   175 ::
       
   176 
       
   177   MIT  LICENSE_MIT
       
   178 
       
   179 BSD file.
       
   180 ---------
       
   181 ::
       
   182 
       
   183   BSD  LICENSE_BSD
       
   184 
       
   185 GPL file.
       
   186 ---------
       
   187 ::
       
   188 
       
   189   GPL-2    GPL2
       
   190   GPL-2.0
       
   191   GPL-3.0  GPL3
       
   192   LICENSE-GPL
       
   193 
       
   194 LGPL file.
       
   195 ----------
       
   196 ::
       
   197 
       
   198   LGPL-2   LGPL-2.0  LGPL-2.1  LGPL-3.0  LICENSE_LGPL
       
   199 
       
   200 Developer files.
       
   201 ================
       
   202 
       
   203 HACKING/DEVELOPERS/PORTING file.
       
   204 --------------------------------
       
   205 
       
   206  * Notes for developers.
       
   207 
       
   208 CONTENTS file.
       
   209 --------------
       
   210 
       
   211  * Description which file for which comes.
       
   212 
       
   213 CONTRIBUTE file.
       
   214 ----------------
       
   215 
       
   216  * Guidelines to contribute to the project.
       
   217 
       
   218 ::
       
   219 
       
   220   CONTRIB
       
   221   CONTRIBS
       
   222   CONTRIBUTE
       
   223   Contributing
       
   224   HOW-TO-CONTRIBUTE
       
   225 
       
   226 DEBUG/DEBUGGING file.
       
   227 ---------------------
       
   228 
       
   229  * How debug sources, useful macros/function/tips.
       
   230 
       
   231 DESIGN/INTERNALS file.
       
   232 ----------------------
       
   233 
       
   234 CHECK_NOTES file.
       
   235 -----------------
       
   236 
       
   237  * How and when test passed by which platform/configuration.
       
   238 
       
   239 BINDINGS file.
       
   240 --------------
       
   241 
       
   242  * Known bindings of library to different langs/frameworks.
       
   243 
       
   244 Coding style files.
       
   245 -------------------
       
   246 ::
       
   247 
       
   248   C++STYLE
       
   249   CodeStyle
       
   250 
       
   251 CODING file.
       
   252 ------------
       
   253 
       
   254  * project policy and recommendation on coding
       
   255 
       
   256 CONVENTIONS file.
       
   257 -----------------
       
   258 
       
   259 Authors files.
       
   260 ==============
       
   261 
       
   262 AUTHORS/MAINTAINERS file.
       
   263 -------------------------
       
   264 ::
       
   265 
       
   266   AUTHOR  AUTHORS  MAINTAINERS
       
   267 
       
   268  * Usually regular contributors.
    39  * List of project members with contact info (email/phone/home page/address/etc).
   269  * List of project members with contact info (email/phone/home page/address/etc).
    40 
   270 
    41 THANKS/CREDITS file.
   271 CONTRIBUTORS/THANKS/CREDITS/ file.
    42 ====================
   272 ----------------------------------
    43 
   273 
    44 Usually casual/non-regular contributors.
   274  * Irregular contributor list.
    45 
   275  * Usually casual/non-regular contributors.
    46  * List of contributors with contact info (email/phone/home page/address/etc).
   276 
    47 
   277 ACKNOWLEDGEMENTS file.
    48 NEWS/CHANGES/ANNOUNCE file.
   278 ----------------------
    49 ===========================
   279 
       
   280 DEDICATION file.
       
   281 ----------------
       
   282 
       
   283 Project changes files.
       
   284 ======================
    50 
   285 
    51 Here goes news and descriptions of user visible changes:
   286 Here goes news and descriptions of user visible changes:
    52 
   287 
    53  * Important project news.
   288  * Important project news.
    54  * New features.
   289  * New features.
    55  * Obsolescense/deprecation of UIs/APIs/protocols/formats.
   290  * Obsolescense/deprecation of UIs/APIs/protocols/formats.
    56  * Incompatibilities with previous version.
   291  * Incompatibilities with previous version.
    57 
   292 
    58 HISORY file.
   293 ChangeLog file.
       
   294 ---------------
       
   295 ::
       
   296 
       
   297   changelog  Changelog  ChangeLog
       
   298   CHANGELOG
       
   299   ChangeLog-1996-1999   ChangeLog-2000
       
   300   ChangeLogOld
       
   301 
       
   302 COMPAT/COMPLIANCE file.
       
   303 -----------------------
       
   304 
       
   305  * Compatibility with previous versions.
       
   306 
       
   307 NEWS/OLDNEWS/ONEWS file.
       
   308 ------------------------
       
   309 
       
   310  * User-visible changes.
       
   311 
       
   312 CHANGES file.
       
   313 -------------
       
   314 ::
       
   315 
       
   316   changes
       
   317   Changes
       
   318   CHANGES
       
   319   CHANGES-beta
       
   320   CHANGES-msw
       
   321   CHANGES-release
       
   322 
       
   323 ANNOUNCE file.
       
   324 --------------
       
   325 
       
   326 Todo files.
       
   327 ===========
       
   328 
       
   329  * list of wanted, roadmap
       
   330 
       
   331 ::
       
   332   BACKLOG
       
   333   CHECKLIST
       
   334   todo       TODO
       
   335   PROJECTS
       
   336 
       
   337 PROGRESS file.
       
   338 ==============
       
   339 
       
   340 Version info files.
       
   341 ===================
       
   342 
       
   343 ANNOUNCE file.
       
   344 --------------
       
   345 ::
       
   346 
       
   347   ANNOUNCE
       
   348   ANNOUNCEMENT
       
   349 
       
   350 HISTORY file.
    59 ============
   351 ============
    60 
   352 
    61  * Project history in long perspective.
   353  * Project history in long perspective.
    62 
   354 
    63 FAQ file.
   355 FUTURE file.
    64 =========
   356 ============
       
   357 
       
   358 
       
   359 Documentation files.
       
   360 ====================
       
   361 
       
   362 Refcard files.
       
   363 --------------
       
   364 ::
       
   365 
       
   366   cheatsheet
       
   367   refcard
       
   368 
       
   369 FAQ files.
       
   370 ----------
    65 
   371 
    66  * List of frequency asked questions with answers.
   372  * List of frequency asked questions with answers.
       
   373 
       
   374 TIPS/HINTS file.
       
   375 ----------------
       
   376 
       
   377 HOWTO file.
       
   378 -----------
       
   379 
       
   380 Bug report instructions.
       
   381 ========================
       
   382 ::
       
   383 
       
   384   BUGFORM
       
   385   BUG-REPORTING
       
   386   BUG-REPORTS
       
   387   BUGS
       
   388 
       
   389 BINDINGS file.
       
   390 ==============
       
   391 
       
   392 Reference.
       
   393 ==========
       
   394 
       
   395   /usr/share/doc/common-licenses/*
       
   396                 from Cygwin 'base-files' package, list of licence files
       
   397 
       
   398