From 32be99433569ceff48a95ca7d15d3f32d5aded2a Mon Sep 17 00:00:00 2001 From: Willy Sudiarto Raharjo Date: Sun, 4 Dec 2016 06:54:11 +0700 Subject: README: Update template. Signed-off-by: Willy Sudiarto Raharjo --- README | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index cbe82e6..a45b6aa 100644 --- a/README +++ b/README @@ -1,4 +1,16 @@ -Template scripts and support files for SlackBuilds.org - -https://slackbuilds.org/templates/ +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. +Some common rules for README: +- Maximum of 72 characters on each line +- Use 2-4 spaces and avoid TAB character +- Plain ASCII is preferred +- Do not include 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. -- cgit v1.2.3