aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README6
1 files changed, 5 insertions, 1 deletions
diff --git a/README b/README
index 899e26d..08dcffa 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
sbo-maintainer-tools
---------------------
+====================
These are "lint" tools to make life easier for SlackBuilds.org
maintainers and admins. They check your builds and packages for
@@ -8,6 +8,7 @@ will be less work for the admins to do when reviewing your build for
approval.
Included tools:
+---------------
- sbolint: checks your SlackBuild, README, .info file, and slack-desc.
@@ -25,6 +26,7 @@ tests aren't perfect, of course, and there are exceptions to almost
every rule).
Installation:
+-------------
The easiest way to install sbo-maintainer-tools is to install them
from SBo (system/sbo-maintainer-tools). The SBo build might be out
@@ -44,6 +46,7 @@ directory in your $PATH (e.g. if you keep your local scripts in
~/bin).
Git Hook:
+---------
To use the git hook, copy pre-commit-sbolint to .git/hooks/pre-commit
in your git work tree (wherever you cloned the SBo repository),
@@ -61,6 +64,7 @@ If you find yourself having to do this often, please contact the SBo
admins and explain the situation; it may mean sbolint needs updating.
Documentation:
+--------------
For more information, see the sbolint and sbopkglint man pages (or
run the scripts with --doc; it's the same thing). There's also a