diff options
| -rw-r--r-- | README | 25 |
1 files changed, 12 insertions, 13 deletions
@@ -1,16 +1,15 @@ -README is used to display SHORT description of an application and some -additional instructions on how to build or use the package. -You may list additional (optional) dependencies needed to enable new features. +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 README: -- Maximum of 72 characters on each line -- Use 2-4 spaces and avoid TAB character +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 homepage URL -- Additional notes before building +- Do not include the homepage URL +- Additional notes before building: * user/group creation along with correct UID/GID - * strict dependency build order - * conflict with Slackware's package - -If you need to have longer instructions, please consider to have an -additional README file, such as README.SBo or README.Slackware. + * strict dependency build order if necessary + * conflicts with any stock Slackware packages + +If longer instructions are necessary, place them in a README.SBo file. |