devel-proj-files.rst
changeset 897 b4d7d3091494
child 900 7cdf5de5fdf7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/devel-proj-files.rst	Wed Jul 20 10:51:44 2011 +0300
@@ -0,0 +1,65 @@
+
+Project sources.
+================
+
+README file.
+============
+
+Assumed that users first read this file before start using project.
+
+ * Project name.
+ * Project goal.
+ * Point to license statements.
+ * Point to build instructions.
+ * Point to documentations.
+
+INSTALL file.
+=============
+
+ * List of supported platform.
+ * Build dependencies/prerequisites.
+ * Build instructions.
+
+COPYING/LICENSE 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:
+
+  LICENSE.libmy LICENSE.regex LICENSE.doc
+
+AUTHORS file.
+=============
+
+Usually regular contributors.
+
+ * List of project members with contact info (email/phone/home page/address/etc).
+
+THANKS/CREDITS file.
+====================
+
+Usually casual/non-regular contributors.
+
+ * List of contributors with contact info (email/phone/home page/address/etc).
+
+NEWS/CHANGES/ANNOUNCE file.
+===========================
+
+Here goes news and descriptions of user visible changes:
+
+ * Important project news.
+ * New features.
+ * Obsolescense/deprecation of UIs/APIs/protocols/formats.
+ * Incompatibilities with previous version.
+
+HISORY file.
+============
+
+ * Project history in long perspective.
+
+FAQ file.
+=========
+
+ * List of frequency asked questions with answers.