Merge pull request #1 from danixland/add-readme

README: add initial README.md

1 files changed, 57 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f1d4954
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# my-slackbuilds
+
+Personal collection of SlackBuild scripts by danix, following
+[SlackBuilds.org (SBo)](https://slackbuilds.org) conventions.
+
+Primarily targeting **Slackware64-current**.
+
+---
+
+## Repository Structure
+
+Each package lives in its own top-level directory:
+
+```
+<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
+```
+
+---
+
+## 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/danix/my-slackbuilds.git
+cd my-slackbuilds
+
+# Download the source and verify checksums
+sbodl <package-name>/
+
+# Log in as root, then build the package
+cd <package-name>
+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.
+
+---
+
+## License
+
+GPL-2.0 — see [LICENSE](LICENSE).