aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-09-25 20:44:38 +0200
committerDanilo M. <danix@danix.xyz>2026-09-25 20:44:38 +0200
commitc92bdd69fe19dca126469bb1c0bc3a598917af9d (patch)
treec1a9051bfa92b73a3068d857306d7ac00148577d /README.md
downloadslackrepo_setup-c92bdd69fe19dca126469bb1c0bc3a598917af9d.tar.gz
slackrepo_setup-c92bdd69fe19dca126469bb1c0bc3a598917af9d.zip
Initial import: SBo-danix repo setup, sbshadow, sbpull
slackrepo_setup_SBo-danix.sh rebuilds the personal SBo-danix repo from upstream plus the personal and pentesting subtree overlays. Shadowing is delegated to sbshadow, which reconciles both ways against the pristine current branch (shadow packages now carried in an overlay, restore those no longer carried) and then runs mkhint -F. sbpull.bash provides the sbpull shell function that pulls one overlay subtree and runs sbshadow. Licensed GPLv2 only. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ab7a7b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# slackrepo_setup
+
+Builds a personal Slackware SlackBuilds repository for
+[slackrepo](https://github.com/aclemons/slackrepo) at `/var/lib/sbopkg/SBo-danix`,
+targeting slackware64-current.
+
+The upstream SBo tree (`Ponce/slackbuilds`, branch `current`) is cloned, then two
+personal overlays are added as squashed git subtrees:
+
+- `personal/` from [my-slackbuilds](https://github.com/danixland/my-slackbuilds)
+- `pentesting/` from [Slackware-Pentesting-Suite](https://github.com/danixland/Slackware-Pentesting-Suite)
+
+Any upstream package also carried in an overlay is *shadowed* (removed from the
+upstream tree), so the overlay version wins.
+
+## Files
+
+- `slackrepo_setup_SBo-danix.sh`: full rebuild. Wipes the repo, clones upstream,
+ adds the subtrees, then runs `sbshadow`. **Destructive**: `rm -rf`s the repo
+ on every run.
+- `sbshadow`: reconciles shadowing both ways. Shadows upstream packages now
+ carried in an overlay, and restores (unshadows) upstream packages no longer
+ carried, from the pristine `current` branch. Asks once before changing
+ anything, commits, then runs `mkhint -F` to regenerate phantom-dep hintfiles.
+- `sbpull.bash`: `sbpull {personal|pentesting}` shell function. Pulls one
+ overlay subtree and runs `sbshadow`, to carry overlay changes without a full
+ rebuild. Source it from root's `~/.bashrc`.
+
+## Install
+
+```bash
+install -m 755 slackrepo_setup_SBo-danix.sh sbshadow /usr/local/bin/
+echo ". /path/to/sbpull.bash" >> ~/.bashrc
+```
+
+Optional: `mkhint` (mkhintfile repo) for phantom-dep hintfile
+regeneration. Without it, `sbshadow` prints a note and skips that step.
+
+## Usage
+
+```bash
+slackrepo_setup_SBo-danix.sh # weekly full rebuild
+sbpull personal # pull overlay changes in between
+```
+
+## License
+
+GPLv2 only. See [LICENSE](LICENSE).
+
+## Development Approach
+
+This project is developed using AI-assisted tools. Code is generated with the help of AI based on human-provided specifications, design decisions, and iterative feedback.
+
+All contributions are reviewed, tested, and curated by the maintainer before being included in the codebase. AI is used as a productivity and exploration tool, while human oversight remains central to all decisions.
+
+The goal is to combine the flexibility of AI-assisted development with standard open-source practices such as transparency, review, and accountability.