cpet/openbsd-ports
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a template for pkg-readmes.

Browse Source 
Currently one needs protective glasses to read a random README; so new
READMEs should be in line with the simple "rules" layed out here.

OK aja@ naddy@ sthen@
This commit is contained in:
jasper 2010-11-23 15:58:54 +00:00
parent b4d5a275e3
commit a9b9525ca0
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
infrastructure/templates/README.template Normal file
View File

@ -0,0 +1,32 @@
Below is a README template for use with ports that need further setup or
configuration to run on OpenBSD. Please keep an eye out for the following
details:
- maximum width of 72 characters per column;
- file must start with the RCS ID;
- no trailing spaces or newlines;
- rulers should be the length of the above string.
------------------------8<------------------------
$OpenBSD: README.template,v 1.1 2010/11/23 15:58:54 jasper Exp $
Running PROJECT FOO on OpenBSD
==============================
Section name 1:
---------------
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non feugiat
mi. Donec lacinia pretium ligula, quis luctus nunc lobortis non. Nam
eget justo nunc.
Section name 2:
---------------
Proin mollis eros vel nibh consequat egestas. Quisque a massa augue.
Donec vel justo lacus. Nam consequat hendrerit tempus. Phasellus rhoncus
hendrerit purus, eu volutpat erat vulputate non.
Section name 3:
---------------
Phasellus ut ipsum nulla. Aliquam lacus ligula, vulputate dignissim
tristique eget, laoreet a risus. Mauris ullamcorper consectetur
accumsan.
------------------------8<------------------------