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 2228 837f1337c59b
parent 1912 8b81a8f0f692 
--- a/devel-proj-files.rst	Sat Feb 10 01:28:53 2018 +0200
+++ b/devel-proj-files.rst	Sat Feb 10 01:30:24 2018 +0200
@@ -9,24 +9,24 @@
 Additional reading.
 ===================
 
- * http://autotoolset.sourceforge.net/tutorial.html
- * https://openide.netbeans.org/tutorial/questions.html
+* http://autotoolset.sourceforge.net/tutorial.html
+* https://openide.netbeans.org/tutorial/questions.html
 
 Essential project files.
 ========================
 
- * README
- * INSTALL
- * COPYING/LICENSE
- * AUTHORS
- * CHANGES
+* README
+* INSTALL
+* COPYING/LICENSE
+* AUTHORS
+* CHANGES
 
 This files can have suffixes to represent formating syntax:
 
- * ``.txt`` - plain text
- * ``.rst`` - reStructuredText
- * ``.md`` - Markdown
- * ``.rd``, ``.rdoc`` - RDtool
+* ``.txt`` - plain text
+* ``.rst`` - reStructuredText
+* ``.md`` - Markdown
+* ``.rd``, ``.rdoc`` - RDtool
 
 and optionally compressed - ``.gz``.
 
@@ -35,23 +35,23 @@
 
 Assumed that users first read this file before start using project.
 
- * Project name.
- * Project goal/purpose.
- * Point to license statements.
- * Point to build instructions.
- * Point to documentations.
- * Use README-xxx for specific topic.
+* Project name.
+* Project goal/purpose.
+* Point to license statements.
+* Point to build instructions.
+* Point to documentations.
+* Use README-xxx for specific topic.
 
 ABOUT/OVERVIEW/SUMMARY file.
 ============================
 
- * About project.
- * Use ABOUT-xxx for specific topic.
+* About project.
+* Use ABOUT-xxx for specific topic.
 
 ABOUT-NLS file.
 ===============
 
- * Notes on the Free Translation Project.
+* Notes on the Free Translation Project.
 
 NOTES/NOTICE file.
 ==================
@@ -62,12 +62,12 @@
 MIRRORS/WHERE file.
 ===================
 
- * Where get src/build, mirrors list.
+* Where get src/build, mirrors list.
 
 PLATFORMS file.
 ===============
 
- * Supported platforms and compilers.
+* Supported platforms and compilers.
 
 AUTHORS/MAINTAINERS file.
 =========================
@@ -75,10 +75,10 @@
 
   AUTHOR  AUTHORS  MAINTAINERS
 
- * Was maintained for legal reasons.
- * Regular contributor list.
- * List of project members with contact info (email, phone, home page, address,
-   etc).
+* Was maintained for legal reasons.
+* Regular contributor list.
+* List of project members with contact info (email, phone, home page, address,
+  etc).
 
 CONTRIBUTORS/THANKS/CREDITS file.
 =================================
@@ -86,9 +86,9 @@
 
   CONTRIBUTORS THANKS CREDITS ACKNOWLEDGEMENTS
 
- * Casual/non-regular contributor list.
- * Wasn't maintained for legal reasons.
- * Thanks for hardware/hosting/money etc.
+* Casual/non-regular contributor list.
+* Wasn't maintained for legal reasons.
+* Thanks for hardware/hosting/money etc.
 
 DEDICATION file.
 ================
@@ -99,12 +99,12 @@
 FORK file.
 ==========
 
- * Why this project is fork of another project.
+* Why this project is fork of another project.
 
 COMMANDS file.
 ==============
 
- * brief list of commands for built-in language
+* brief list of commands for built-in language
 
 PROGLIST file.
 ==============
@@ -112,24 +112,24 @@
 UPGRADE/UPGRADING/CONVERSION file.
 ==================================
 
- * How upgrade to new version.
+* How upgrade to new version.
 
 SERVICE/SUPPORT file.
 =====================
 
- * about support services for software
+* about support services for software
 
 INSTALL/BUILD file.
 ===================
 
- * List of supported platform.
- * Build dependencies/prerequisites.
- * Build/installation instructions.
+* List of supported platform.
+* Build dependencies/prerequisites.
+* Build/installation instructions.
 
 CUSTOMIZE file.
 ===============
 
- * Customize the compilation.
+* Customize the compilation.
 
 License files.
 ==============
@@ -167,15 +167,15 @@
 AFL file.
 ---------
 
-Academic Free License.
+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
+* http://www.opensource.org/licenses/afl-3.0.php
+* http://en.wikipedia.org/wiki/Academic_Free_License
 
 Apache file.
 ------------
@@ -225,17 +225,17 @@
 HACKING/DEVELOPERS/PORTING file.
 --------------------------------
 
- * Notes for developers.
+* Notes for developers.
 
 CONTENTS file.
 --------------
 
- * Description which file for which comes.
+* Description which file for which comes.
 
 CONTRIBUTE file.
 ----------------
 
- * Guidelines to contribute to the project.
+* Guidelines to contribute to the project.
 
 ::
 
@@ -248,7 +248,7 @@
 DEBUG/DEBUGGING file.
 ---------------------
 
- * How debug sources, useful macros/function/tips.
+* How debug sources, useful macros/function/tips.
 
 DESIGN/INTERNALS/PROTOCOL file.
 -------------------------------
@@ -256,13 +256,13 @@
 TESTS/CHECK_NOTES file.
 -----------------------
 
- * How run/add tests, requirements to run.
- * How and when test passed by which platform/configuration.
+* How run/add tests, requirements to run.
+* How and when test passed by which platform/configuration.
 
 BINDINGS file.
 --------------
 
- * Known bindings of library to different langs/frameworks.
+* Known bindings of library to different langs/frameworks.
 
 Coding style files.
 -------------------
@@ -274,7 +274,7 @@
 CODING file.
 ------------
 
- * project policy and recommendation on coding
+* project policy and recommendation on coding
 
 CONVENTIONS file.
 -----------------
@@ -284,17 +284,17 @@
 
 Here goes news and descriptions of user visible changes:
 
- * Important project news.
- * New features.
- * Obsolescense/deprecation of UIs/APIs/protocols/formats.
+* Important project news.
+* New features.
+* Obsolescense/deprecation of UIs/APIs/protocols/formats.
 
 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).
+* 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).
 
 ::
 
@@ -306,17 +306,17 @@
 COMPAT/COMPLIANCE file.
 -----------------------
 
- * Compatibility with previous versions.
+* Compatibility with previous versions.
 
 NEWS/OLDNEWS/ONEWS file.
 ------------------------
 
- * 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.
+* 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.
 ----------------------
@@ -334,9 +334,9 @@
 Todo files.
 ===========
 
- * List of high level wanted, general project roadmap.
- * Discussion about product limitations and how to modify product to resolve
-   them.
+* List of high level wanted, general project roadmap.
+* Discussion about product limitations and how to modify product to resolve
+  them.
 
 Similar::
 
@@ -354,10 +354,10 @@
 VERSION file.
 -------------
 
- * Package version.
- * Package name (optional).
- * Release naming schema and version number semantics (optional).
- * Release names and version relations (like starts, toys, animals, etc, optional).
+* Package version.
+* Package name (optional).
+* Release naming schema and version number semantics (optional).
+* Release names and version relations (like starts, toys, animals, etc, optional).
 
 RELDATE/RELEASE-DATE file.
 --------------------------
@@ -369,13 +369,13 @@
   ANNOUNCE
   ANNOUNCEMENT
 
- * Only current release changes and notes. No history. Same text was sent to
-   mail lists as announce.
+* Only current release changes and notes. No history. Same text was sent to
+  mail lists as announce.
 
 HISTORY file.
 =============
 
- * Project history in long perspective.
+* Project history in long perspective.
 
 FUTURE file.
 ============
@@ -397,7 +397,7 @@
 FAQ files.
 ----------
 
- * List of frequency asked questions with answers.
+* List of frequency asked questions with answers.
 
 TIPS/HINTS file.
 ----------------
@@ -429,8 +429,8 @@
 Reference.
 ==========
 
-  /usr/share/doc/common-licenses/*
-                from Cygwin 'base-files' package, list of licence files
+``/usr/share/doc/common-licenses/*``
+  From Cygwin 'base-files' package, list of licence files.
 
 Unknown files.
 ==============
@@ -453,6 +453,6 @@
 Reference.
 ==========
 
- * GNU Coding Standards
- * Gnits Standards
+* GNU Coding Standards
+* Gnits Standards
tips