summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
author Erik Hanson <erik@slackbuilds.org>2016-12-05 10:11:18 -0600
committer Robby Workman <rworkman@slackware.com>2016-12-05 22:31:53 -0600
commit7270dfaa6d93b53dba361ed9db44d8167a9b0fd1 (patch)
tree6f569a271dece97ec19e0a7dba860be5e693dae1
parent32be99433569ceff48a95ca7d15d3f32d5aded2a (diff)
downloadtemplates-7270dfaa6d93b53dba361ed9db44d8167a9b0fd1.tar.gz
templates-7270dfaa6d93b53dba361ed9db44d8167a9b0fd1.tar.xz
README: Cleanups.
Some rephrasing, removed white-space, wrapped at 72 chars. Signed-off-by: Robby Workman <rworkman@slackbuilds.org>
-rw-r--r--README25
1 files changed, 12 insertions, 13 deletions
diff --git a/README b/README
index a45b6aa..044a76c 100644
--- a/README
+++ b/README
@@ -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.