Mercurial Mercurial > tips / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
devel-proj-files.rst
changeset 907 5c1e6ce7ddac
parent 900 7cdf5de5fdf7
child 908 660c0dac57c2 
--- a/devel-proj-files.rst	Wed Jul 20 15:48:37 2011 +0300
+++ b/devel-proj-files.rst	Thu Jul 21 17:06:59 2011 +0300
@@ -1,7 +1,83 @@
 .. contents::
 
-Project sources.
-================
+Essential project files.
+========================
+
+ * README
+ * INSTALL
+ * 
+
+General info files.
+===================
+
+README file.
+------------
+
+ABOUT/OVERVIEW file.
+--------------------
+
+ABOUT-NLS file.
+---------------
+
+ * Notes on the Free Translation Project.
+
+NOTES/NOTICE file.
+------------------
+
+FEATURES file.
+--------------
+
+FEEDBACK file.
+--------------
+
+PLATFORMS file.
+---------------
+
+ * Supported platforms and compilers.
+
+PROBLEMS/KNOWNBUG file.
+-----------------------
+::
+
+  PROBLEMS  KNOWNBUG  KNOWN_BUGS  KNOWN-BUGS
+
+FORK file.
+----------
+
+ * Why this project is fork of another project.
+
+COMMANDS file.
+--------------
+
+ * brief list of commands for built-in language
+
+PROGLIST file.
+--------------
+
+UPGRADE/UPGRADING/CONVERSION file.
+----------------------------------
+
+ * How upgrade to new version.
+
+MIRRORS file.
+-------------
+
+Thanks files.
+=============
+::
+
+  ACKNOWLEDGEMENTS
+
+Contributors files.
+===================
+
+AUTHOR file.
+------------
+::
+
+  authors
+  AUTHOR
+  AUTHORS
 
 README file.
 ============
@@ -14,39 +90,198 @@
  * Point to build instructions.
  * Point to documentations.
 
+ABOUT file.
+===========
+
+ * About project.
+ * In form of 'ABOUT-xxx' - about topic 'xxx'.
+
+Build/install instruction.
+==========================
+
 INSTALL file.
-=============
+-------------
 
  * List of supported platform.
  * Build dependencies/prerequisites.
  * Build instructions.
 
-COPYING/LICENSE file.
-=====================
+BUILD file.
+-----------
+
+CUSTOMIZE file.
+---------------
+
+ * Customize the compilation.
+
+License files.
+==============
+
+DISCLAIMER file.
+----------------
+
+PATENTS file.
+-------------
+
+COPYING/LICENSE/LEGAL file.
+---------------------------
 
 COPYING usually used for GNU GPL like license. Another license put in LICENSE
 file.
 
-If some component comes with different license put it into file with name like:
+If some component comes with different license put it into file with name like::
 
   LICENSE.libmy LICENSE.regex LICENSE.doc
+  COPYING-DOCS  COPYING-GPL   COPYING-LGPL  COPYING-LIBS  COPYING-TEMPLATES
 
-AUTHORS file.
-=============
+COPYRIGHT file.
+---------------
+::
+
+  copyright
+  COPYRIGHT
+  copyright-artwork
+  copyright-notice
+
+AFL file.
+---------
+
+Academic Free License.
+
+  AFL-1.1
+  AFL-1.2
+  AFL-2.0
+  AFL-2.1
+
+ * http://www.opensource.org/licenses/afl-3.0.php
+ * http://en.wikipedia.org/wiki/Academic_Free_License
+
+Apache file.
+------------
+::
+
+  Apache-1.0
+  Apache-1.1
+  Apache-2.0
+
+PHP file.
+---------
+::
+
+  PHP-3.0
+
+MIT file.
+---------
+::
+
+  MIT  LICENSE_MIT
+
+BSD file.
+---------
+::
+
+  BSD  LICENSE_BSD
+
+GPL file.
+---------
+::
+
+  GPL-2    GPL2
+  GPL-2.0
+  GPL-3.0  GPL3
+  LICENSE-GPL
+
+LGPL file.
+----------
+::
+
+  LGPL-2   LGPL-2.0  LGPL-2.1  LGPL-3.0  LICENSE_LGPL
+
+Developer files.
+================
 
-Usually regular contributors.
+HACKING/DEVELOPERS/PORTING file.
+--------------------------------
+
+ * Notes for developers.
+
+CONTENTS file.
+--------------
+
+ * Description which file for which comes.
+
+CONTRIBUTE file.
+----------------
+
+ * Guidelines to contribute to the project.
+
+::
+
+  CONTRIB
+  CONTRIBS
+  CONTRIBUTE
+  Contributing
+  HOW-TO-CONTRIBUTE
+
+DEBUG/DEBUGGING file.
+---------------------
+
+ * How debug sources, useful macros/function/tips.
+
+DESIGN/INTERNALS file.
+----------------------
 
+CHECK_NOTES file.
+-----------------
+
+ * How and when test passed by which platform/configuration.
+
+BINDINGS file.
+--------------
+
+ * Known bindings of library to different langs/frameworks.
+
+Coding style files.
+-------------------
+::
+
+  C++STYLE
+  CodeStyle
+
+CODING file.
+------------
+
+ * project policy and recommendation on coding
+
+CONVENTIONS file.
+-----------------
+
+Authors files.
+==============
+
+AUTHORS/MAINTAINERS file.
+-------------------------
+::
+
+  AUTHOR  AUTHORS  MAINTAINERS
+
+ * Usually regular contributors.
  * List of project members with contact info (email/phone/home page/address/etc).
 
-THANKS/CREDITS file.
-====================
+CONTRIBUTORS/THANKS/CREDITS/ file.
+----------------------------------
 
-Usually casual/non-regular contributors.
+ * Irregular contributor list.
+ * Usually casual/non-regular contributors.
 
- * List of contributors with contact info (email/phone/home page/address/etc).
+ACKNOWLEDGEMENTS file.
+----------------------
 
-NEWS/CHANGES/ANNOUNCE file.
-===========================
+DEDICATION file.
+----------------
+
+Project changes files.
+======================
 
 Here goes news and descriptions of user visible changes:
 
@@ -55,12 +290,109 @@
  * Obsolescense/deprecation of UIs/APIs/protocols/formats.
  * Incompatibilities with previous version.
 
-HISORY file.
+ChangeLog file.
+---------------
+::
+
+  changelog  Changelog  ChangeLog
+  CHANGELOG
+  ChangeLog-1996-1999   ChangeLog-2000
+  ChangeLogOld
+
+COMPAT/COMPLIANCE file.
+-----------------------
+
+ * Compatibility with previous versions.
+
+NEWS/OLDNEWS/ONEWS file.
+------------------------
+
+ * User-visible changes.
+
+CHANGES file.
+-------------
+::
+
+  changes
+  Changes
+  CHANGES
+  CHANGES-beta
+  CHANGES-msw
+  CHANGES-release
+
+ANNOUNCE file.
+--------------
+
+Todo files.
+===========
+
+ * list of wanted, roadmap
+
+::
+  BACKLOG
+  CHECKLIST
+  todo       TODO
+  PROJECTS
+
+PROGRESS file.
+==============
+
+Version info files.
+===================
+
+ANNOUNCE file.
+--------------
+::
+
+  ANNOUNCE
+  ANNOUNCEMENT
+
+HISTORY file.
 ============
 
  * Project history in long perspective.
 
-FAQ file.
-=========
+FUTURE file.
+============
+
+
+Documentation files.
+====================
+
+Refcard files.
+--------------
+::
+
+  cheatsheet
+  refcard
+
+FAQ files.
+----------
 
  * List of frequency asked questions with answers.
+
+TIPS/HINTS file.
+----------------
+
+HOWTO file.
+-----------
+
+Bug report instructions.
+========================
+::
+
+  BUGFORM
+  BUG-REPORTING
+  BUG-REPORTS
+  BUGS
+
+BINDINGS file.
+==============
+
+Reference.
+==========
+
+  /usr/share/doc/common-licenses/*
+                from Cygwin 'base-files' package, list of licence files
+
+
tips