README
authorOleksandr Gavenko <gavenkoa@gmail.com>
Thu, 21 Jul 2011 18:00:59 +0300
changeset 909 42a2f77b2b90
parent 908 660c0dac57c2
child 910 c3fc5f36d101
README
devel-proj-files.rst
--- a/devel-proj-files.rst	Thu Jul 21 17:18:08 2011 +0300
+++ b/devel-proj-files.rst	Thu Jul 21 18:00:59 2011 +0300
@@ -13,6 +13,7 @@
 README file.
 ------------
 
+ * README file should refer to the file INSTALL and copying conditions.
  * Use README-xxx for specific topic.
 
 ABOUT/OVERVIEW/SUMMARY file.
@@ -115,7 +116,7 @@
 
  * List of supported platform.
  * Build dependencies/prerequisites.
- * Build instructions.
+ * Build/installation instructions.
 
 BUILD file.
 -----------
@@ -147,6 +148,7 @@
 
   LICENSE.libmy LICENSE.regex LICENSE.doc
   COPYING-DOCS  COPYING-GPL   COPYING-LGPL  COPYING-LIBS  COPYING-TEMPLATES
+  COPYING.LESSER
 
 COPYRIGHT file.
 ---------------
@@ -210,6 +212,7 @@
 ::
 
   LGPL-2   LGPL-2.0  LGPL-2.1  LGPL-3.0  LICENSE_LGPL
+  COPYING.LESSER
 
 Developer files.
 ================
@@ -307,6 +310,12 @@
 
 ChangeLog file.
 ---------------
+
+ * Changes made to program source files.
+ * Explains how earlier versions were different from the current version.
+ * Each directory can have its own change log.
+ * Useful for RCS/CVS. Don't needed with modern VCS (SVN, Git, Mercurial, Bazaar).
+
 ::
 
   changelog  Changelog  ChangeLog
@@ -323,6 +332,11 @@
 ------------------------
 
  * User-visible changes.
+ * In each new release, add items to the front of the file and identify the
+   version they pertain to.
+ * Don't discard old items.
+ * NEWS file gets very long, move some of the older items into a file named
+   ONEWS and put a note at the end referring the user to that file.
 
 CHANGES/WHATSNEW file.
 ----------------------
@@ -365,7 +379,7 @@
   ANNOUNCEMENT
 
 HISTORY file.
-============
+=============
 
  * Project history in long perspective.
 
@@ -433,3 +447,9 @@
   ROADMAP
   TRACING
 
+Reference.
+==========
+
+ * GNU Coding Standards
+ * Gnits Standards
+