Mirror of the Rel4tion website/wiki source, view at <http://rel4tion.org>

Clone

HTTPS: git clone https://vervis.peers.community/repos/yEzqv

SSH: git clone USERNAME@vervis.peers.community:yEzqv

Branches

• master

Tags

features

readme.mdwn

The following is (probably) partially taken from GNU conventions.

The distribution should contain a file named README with a general overview of the package:

• the name of the package;
• the version number of the package, or refer to where in the package the version can be found;
• a general description of what the package does;
• a reference to the file INSTALL, which should in turn contain an explanation of the installation procedure;
• a brief explanation of any unusual top-level directories or files, or other hints for readers to find their way around the source;
• a reference to the file which contains the copying conditions. The GNU GPL, if used, should be in a file called COPYING.
• If the GNU LGPL is used, it should be in a file called COPYING.LESSER.
• Also look at READMEs of Gnome modules. They seem to have a common format, which I can adopt. At least partially. And look at GNU Hello’s README too.

I wrote a thorough README for libKort. Use that as a basis for the README of the skeletons.