diff -r 9559bd5727fb -r 8cfa61142672 devel-proj-files.rst --- a/devel-proj-files.rst Sun Nov 18 01:53:55 2012 +0200 +++ b/devel-proj-files.rst Mon Nov 19 20:57:51 2012 +0200 @@ -6,6 +6,11 @@ ============================ .. contents:: +Additional reading. +=================== + + * http://autotoolset.sourceforge.net/tutorial.html + Essential project files. ======================== @@ -24,136 +29,104 @@ and optionally compressed - ``.gz``. -General info files. -=================== - -README file. ------------- - - * README file should refer to the file INSTALL and copying conditions. - * Use README-xxx for specific topic. - -ABOUT/OVERVIEW/SUMMARY 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/WARNINGS file. --------------------------------- -:: - - PROBLEMS - KNOWNBUG KNOWN_BUGS KNOWN-BUGS - WARNINGS - -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/WHERE file. -------------------- - - * Where get src/build, mirrors list. - -SERVICE/SUPPORT file. ---------------------- - - * about support services for software - -Thanks files. -============= -:: - - ACKNOWLEDGEMENTS - -AUTHORS/THANKS files. -===================== - -AUTHORS/MAINTAINERS file. -------------------------- -:: - - AUTHOR AUTHORS MAINTAINERS - - * Regular contributor list. - * List of project members with contact info (email, phone, home page, address, - etc). - -CONTRIBUTORS/THANKS/CREDITS file. ---------------------------------- -:: - - CONTRIBUTORS THANKS CREDITS ACKNOWLEDGEMENTS - - * Casual/non-regular contributor list. - * Thanks for hardware/hosting/money etc. - -DEDICATION file. ----------------- - README file. ============ Assumed that users first read this file before start using project. * Project name. - * Project goal. + * Project goal/purpose. * Point to license statements. * Point to build instructions. * Point to documentations. + * Use README-xxx for specific topic. -ABOUT file. -=========== +ABOUT/OVERVIEW/SUMMARY file. +============================ * About project. - * In form of 'ABOUT-xxx' - about topic 'xxx'. + * Use ABOUT-xxx for specific topic. + +ABOUT-NLS file. +=============== + + * Notes on the Free Translation Project. + +NOTES/NOTICE file. +================== + +FEATURES file. +============== + +MIRRORS/WHERE file. +=================== + + * Where get src/build, mirrors list. + +PLATFORMS file. +=============== + + * Supported platforms and compilers. + +AUTHORS/MAINTAINERS file. +========================= +:: + + AUTHOR AUTHORS MAINTAINERS + + * 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. +================================= +:: -Build/install instruction. -========================== + CONTRIBUTORS THANKS CREDITS ACKNOWLEDGEMENTS + + * Casual/non-regular contributor list. + * Wasn't maintained for legal reasons. + * Thanks for hardware/hosting/money etc. + +DEDICATION file. +================ + +FEEDBACK file. +============== + +FORK file. +========== + + * Why this project is fork of another project. -INSTALL file. -------------- +COMMANDS file. +============== + + * brief list of commands for built-in language + +PROGLIST file. +============== + +UPGRADE/UPGRADING/CONVERSION file. +================================== + + * How upgrade to new version. + +SERVICE/SUPPORT file. +===================== + + * about support services for software + +INSTALL/BUILD file. +=================== * List of supported platform. * Build dependencies/prerequisites. * Build/installation instructions. -BUILD file. ------------ - CUSTOMIZE file. ---------------- +=============== * Customize the compilation. @@ -431,6 +404,14 @@ HOWTO file. ----------- +PROBLEMS/KNOWNBUG/WARNINGS file. +================================ +:: + + PROBLEMS + KNOWNBUG KNOWN_BUGS KNOWN-BUGS + WARNINGS + Bug report instructions. ======================== ::