This files can have suffixes to represent formating syntax:
- .txt - plain text
- .rst - reStructuredText
- .md - Markdown
- .rd, .rdoc - RDtool
and optionally compressed - .gz.
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.
- About project.
- Use ABOUT-xxx for specific topic.
- Notes on the Free Translation Project.
- Where get src/build, mirrors list.
- Supported platforms and compilers.
CONTRIBUTORS THANKS CREDITS ACKNOWLEDGEMENTS * Casual/non-regular contributor list. * Wasn't maintained for legal reasons. * Thanks for hardware/hosting/money etc.
- Why this project is fork of another project.
- brief list of commands for built-in language
- How upgrade to new version.
- about support services for software
- List of supported platform.
- Build dependencies/prerequisites.
- Build/installation instructions.
- Customize the compilation.
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 COPYING-DOCS COPYING-GPL COPYING-LGPL COPYING-LIBS COPYING-TEMPLATES COPYING.LESSER
copyright COPYRIGHT copyright-artwork copyright-notice
Academic Free License.
AFL-1.1 AFL-1.2 AFL-2.0 AFL-2.1
Apache-1.0 Apache-1.1 Apache-2.0
GPL-2 GPL2 GPL-2.0 GPL-3.0 GPL3 LICENSE-GPL
LGPL-2 LGPL-2.0 LGPL-2.1 LGPL-3.0 LICENSE_LGPL COPYING.LESSER
- Notes for developers.
- Description which file for which comes.
- Guidelines to contribute to the project.
CONTRIB CONTRIBS CONTRIBUTE Contributing HOW-TO-CONTRIBUTE
- How debug sources, useful macros/function/tips.
- How run/add tests, requirements to run.
- How and when test passed by which platform/configuration.
- Known bindings of library to different langs/frameworks.
- project policy and recommendation on coding
Here goes news and descriptions of user visible changes:
- Important project news.
- New features.
- Obsolescense/deprecation of UIs/APIs/protocols/formats.
- 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 CHANGELOG ChangeLog-1996-1999 ChangeLog-2000 ChangeLogOld
- Compatibility with previous versions.
- 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 CHANGES CHANGES-release RELEASE_NOTES ReleaseNotes RELEASENOTES RELEASE-NOTES RELNOTES SHORTLOG WHATSNEW
- List of high level wanted, general project roadmap.
- Discussion about product limitations and how to modify product to resolve them.
BACKLOG CHECKLIST TODO PROJECTS
- Package version.
- Package name (optional).
- Release naming schema and version number semantics (optional).
- Release names and version relations (like starts, toys, animals, etc, optional).
ANNOUNCE ANNOUNCEMENT * Only current release changes and notes. No history. Same text was sent to mail lists as announce.
- Project history in long perspective.
- List of frequency asked questions with answers.
PROBLEMS KNOWNBUG KNOWN_BUGS KNOWN-BUGS WARNINGS
BUGFORM REPORTING-BUGS BUG-REPORTING BUG-REPORTS BUGS
- from Cygwin 'base-files' package, list of licence files
AUDIT DETAILS FILE-FORMAT Fixes FIXES FORMAT MAIL NEEDED PGPKEYS PKG-INFO - http://www.python.org/dev/peps/pep-0241/ http://www.python.org/dev/peps/pep-0314/ PLACES ROADMAP TRACING
- GNU Coding Standards
- Gnits Standards