aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md103
1 files changed, 103 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..47ec944
--- /dev/null
+++ b/README.md
@@ -0,0 +1,103 @@
+![](.extras/assets/tiles-03-1024x819.jpg)
+
+# sbo-slackbuilds
+
+SlackBuild scripts maintained by danix and submitted to
+[SlackBuilds.org (SBo)](https://slackbuilds.org).
+
+Primarily targeting **Slackware64-current**.
+
+This repository holds only the packages for which danix is the **official SBo
+maintainer**. Experimental and lead packages not (yet) on SBo under danix live
+in the separate [my-slackbuilds](https://github.com/danixland/my-slackbuilds)
+repository.
+
+---
+
+## Repository Structure
+
+Each package lives in its own top-level subfolder:
+
+```
+<package-name>/
+├── <package-name>.SlackBuild # Main build script
+├── <package-name>.info # Metadata (version, checksums, URLs)
+├── README # Description and usage notes
+├── slack-desc # Package description (11-line format)
+└── <package-name>.desktop # (optional) Desktop entry for GUI apps
+```
+
+---
+
+## Packages
+
+| Package | -current | 15.0 | SBo | Version |
+|---------|----------|------|-----|---------|
+| r8125 | ✅ | ✅ | ✅ [r8125](https://slackbuilds.org/repository/15.0/network/r8125/) | 9.018.00 |
+| UrbanTerror | ✅ | ✅ | ✅ [UrbanTerror](https://slackbuilds.org/repository/15.0/games/UrbanTerror/) | 4.3.4 |
+
+---
+
+## Usage
+
+### Prerequisites
+
+- Slackware64-current
+- Root access (required to run `.SlackBuild` scripts)
+- [`sbo-maintainer-tools`](https://slackware.uk/~urchlay/repos/sbo-maintainer-tools) (optional, for linting and source downloads)
+
+### Building a package
+
+```bash
+# Clone the repository
+git clone https://github.com/danixland/sbo-slackbuilds.git
+cd sbo-slackbuilds
+
+# Fix any .info issues automatically
+cd <package-name> && sbofixinfo
+
+# Download the source and verify checksums
+cd <package-name> && sbodl
+
+# Lint the script and metadata
+cd <package-name> && sbolint
+
+# Build the package
+cd <package-name> && sudo bash <package-name>.SlackBuild
+
+# Install the resulting package
+installpkg /tmp/<package-name>-*.t?z
+```
+
+Check each package's `README` for dependencies and any special build instructions.
+
+---
+
+## Git Hooks
+
+Two hooks are included in `.extras/hooks/`. Install them after cloning:
+
+```bash
+cp .extras/hooks/pre-commit .git/hooks/pre-commit
+cp .extras/hooks/post-commit .git/hooks/post-commit
+chmod +x .git/hooks/pre-commit .git/hooks/post-commit
+```
+
+| Hook | Purpose |
+|------|---------|
+| `pre-commit` | Runs [`sbolint`](https://slackware.uk/~urchlay/repos/sbo-maintainer-tools) on staged packages before each commit. Also guards against staged source archives: symlinks are auto-removed silently, real archive files block the commit and list the offenders. |
+| `post-commit` | After each commit, offers to create a `SBo/<pkg>.tar.gz` archive ready for submission to SlackBuilds.org |
+
+---
+
+## License
+
+GPL-2.0 — 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.