a9b9525ca0
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@
33 lines
1.1 KiB
Plaintext
33 lines
1.1 KiB
Plaintext
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<------------------------
|