README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

README is used to display a short description of the application and
any additional instructions on how to build or use the package. You
may list optional dependencies needed to enable additional features.

Some common rules for the README file:
- Maximum of 72 characters per line
- Use 2-4 spaces for indentation, avoid TAB characters
- Plain ASCII is preferred
- Do not include the homepage URL
- Additional notes before building:
  * user/group creation along with correct UID/GID
  * strict dependency build order if necessary
  * conflicts with any stock Slackware packages

If longer instructions are necessary, place them in a README.SBo file.