devel-proj-files.rst
changeset 909 42a2f77b2b90
parent 908 660c0dac57c2
child 910 c3fc5f36d101
equal deleted inserted replaced
908:660c0dac57c2 909:42a2f77b2b90
    11 ===================
    11 ===================
    12 
    12 
    13 README file.
    13 README file.
    14 ------------
    14 ------------
    15 
    15 
       
    16  * README file should refer to the file INSTALL and copying conditions.
    16  * Use README-xxx for specific topic.
    17  * Use README-xxx for specific topic.
    17 
    18 
    18 ABOUT/OVERVIEW/SUMMARY file.
    19 ABOUT/OVERVIEW/SUMMARY file.
    19 ----------------------------
    20 ----------------------------
    20 
    21 
   113 INSTALL file.
   114 INSTALL file.
   114 -------------
   115 -------------
   115 
   116 
   116  * List of supported platform.
   117  * List of supported platform.
   117  * Build dependencies/prerequisites.
   118  * Build dependencies/prerequisites.
   118  * Build instructions.
   119  * Build/installation instructions.
   119 
   120 
   120 BUILD file.
   121 BUILD file.
   121 -----------
   122 -----------
   122 
   123 
   123 CUSTOMIZE file.
   124 CUSTOMIZE file.
   145 
   146 
   146 If some component comes with different license put it into file with name like::
   147 If some component comes with different license put it into file with name like::
   147 
   148 
   148   LICENSE.libmy LICENSE.regex LICENSE.doc
   149   LICENSE.libmy LICENSE.regex LICENSE.doc
   149   COPYING-DOCS  COPYING-GPL   COPYING-LGPL  COPYING-LIBS  COPYING-TEMPLATES
   150   COPYING-DOCS  COPYING-GPL   COPYING-LGPL  COPYING-LIBS  COPYING-TEMPLATES
       
   151   COPYING.LESSER
   150 
   152 
   151 COPYRIGHT file.
   153 COPYRIGHT file.
   152 ---------------
   154 ---------------
   153 ::
   155 ::
   154 
   156 
   208 LGPL file.
   210 LGPL file.
   209 ----------
   211 ----------
   210 ::
   212 ::
   211 
   213 
   212   LGPL-2   LGPL-2.0  LGPL-2.1  LGPL-3.0  LICENSE_LGPL
   214   LGPL-2   LGPL-2.0  LGPL-2.1  LGPL-3.0  LICENSE_LGPL
       
   215   COPYING.LESSER
   213 
   216 
   214 Developer files.
   217 Developer files.
   215 ================
   218 ================
   216 
   219 
   217 HACKING/DEVELOPERS/PORTING file.
   220 HACKING/DEVELOPERS/PORTING file.
   305  * Obsolescense/deprecation of UIs/APIs/protocols/formats.
   308  * Obsolescense/deprecation of UIs/APIs/protocols/formats.
   306  * Incompatibilities with previous version.
   309  * Incompatibilities with previous version.
   307 
   310 
   308 ChangeLog file.
   311 ChangeLog file.
   309 ---------------
   312 ---------------
       
   313 
       
   314  * Changes made to program source files.
       
   315  * Explains how earlier versions were different from the current version.
       
   316  * Each directory can have its own change log.
       
   317  * Useful for RCS/CVS. Don't needed with modern VCS (SVN, Git, Mercurial, Bazaar).
       
   318 
   310 ::
   319 ::
   311 
   320 
   312   changelog  Changelog  ChangeLog
   321   changelog  Changelog  ChangeLog
   313   CHANGELOG
   322   CHANGELOG
   314   ChangeLog-1996-1999   ChangeLog-2000
   323   ChangeLog-1996-1999   ChangeLog-2000
   321 
   330 
   322 NEWS/OLDNEWS/ONEWS file.
   331 NEWS/OLDNEWS/ONEWS file.
   323 ------------------------
   332 ------------------------
   324 
   333 
   325  * User-visible changes.
   334  * User-visible changes.
       
   335  * In each new release, add items to the front of the file and identify the
       
   336    version they pertain to.
       
   337  * Don't discard old items.
       
   338  * NEWS file gets very long, move some of the older items into a file named
       
   339    ONEWS and put a note at the end referring the user to that file.
   326 
   340 
   327 CHANGES/WHATSNEW file.
   341 CHANGES/WHATSNEW file.
   328 ----------------------
   342 ----------------------
   329 ::
   343 ::
   330 
   344 
   363 
   377 
   364   ANNOUNCE
   378   ANNOUNCE
   365   ANNOUNCEMENT
   379   ANNOUNCEMENT
   366 
   380 
   367 HISTORY file.
   381 HISTORY file.
   368 ============
   382 =============
   369 
   383 
   370  * Project history in long perspective.
   384  * Project history in long perspective.
   371 
   385 
   372 FUTURE file.
   386 FUTURE file.
   373 ============
   387 ============
   431   PKG-INFO - http://www.python.org/dev/peps/pep-0241/ http://www.python.org/dev/peps/pep-0314/
   445   PKG-INFO - http://www.python.org/dev/peps/pep-0241/ http://www.python.org/dev/peps/pep-0314/
   432   PLACES
   446   PLACES
   433   ROADMAP
   447   ROADMAP
   434   TRACING
   448   TRACING
   435 
   449 
       
   450 Reference.
       
   451 ==========
       
   452 
       
   453  * GNU Coding Standards
       
   454  * Gnits Standards
       
   455