aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 95b550b..207afc6 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,23 @@ cp .extras/hooks/* .git/hooks/ && chmod 0755 .git/hooks/{pre,post}-commit
prompt non-interactively, set `SBO_ARCHIVE=yes` or `SBO_ARCHIVE=no` in the
environment.
+## Building an SBo archive on demand
+
+`.extras/mksboarchive <package>` builds the same `<package>.tar.gz` SBo
+submission tarball the post-commit hook produces, but on demand by name
+rather than at commit time:
+
+```bash
+.extras/mksboarchive feroxbuster # writes ./feroxbuster.tar.gz
+OUTPUT=/tmp .extras/mksboarchive hydra # writes /tmp/hydra.tar.gz
+```
+
+It validates that `<package>/<package>.SlackBuild` exists, removes any
+`sbodl` source symlinks from the package directory first (so they never leak
+into the tarball), then archives the directory. The output directory defaults
+to the current working directory and can be overridden with the `OUTPUT`
+environment variable. Run it from anywhere; it locates the repo root via git.
+
## Vendored Crates (Rust packages)
Rust packages such as `feroxbuster` build from a vendored crates tarball