aboutsummaryrefslogtreecommitdiff
path: root/QUICKSTART
diff options
context:
space:
mode:
authorB. Watson <yalhcru@gmail.com>2022-04-13 01:41:36 -0400
committerB. Watson <yalhcru@gmail.com>2022-04-13 01:41:36 -0400
commita800d01375d989cefd56011467d26d51815ba2dc (patch)
treeaa52088b7f81798430365a5a89d0cbe6b64a99aa /QUICKSTART
parentdd8c15a01b40e864fd06ebf9c8afce40188c7aad (diff)
downloadsbo-maintainer-tools-a800d01375d989cefd56011467d26d51815ba2dc.tar.gz
update docs
Diffstat (limited to 'QUICKSTART')
-rw-r--r--QUICKSTART21
1 files changed, 21 insertions, 0 deletions
diff --git a/QUICKSTART b/QUICKSTART
new file mode 100644
index 0000000..47d7d52
--- /dev/null
+++ b/QUICKSTART
@@ -0,0 +1,21 @@
+See README for install instructions. Once you have
+sbo-maintainer-tools installed:
+
+You can lint the build you're working on currently by running
+"sbolint" while cd'ed into its directory.
+
+You can lint the *package* (if you've already built one) by running
+"sbopkglint" in the build directory (and entering your password, if
+you're asked for one).
+
+You can also lint any package by giving its filename as an argument
+to sbopkglint. If you have a bunch of already-built packages, you can
+lint them all at once with e.g. "sbopkglint /tmp/*.tgz".
+
+sbolint and sbopkglint each have extensive man pages and --help
+output, which you'll want to read to learn to use the tools
+effectively.
+
+You should also read the sbo-maintainer-tools README, if you haven't
+already. In particular, the README tells you how to set up the git
+hook (which is *very* handy, if you use git).