aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5f98567
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# sb-builder
+
+Desktop GUI for managing a Slackware SlackBuilds build VM from one place. It
+runs slackrepo builds, overlay syncs (sbpull, sbshadow), hintfile work
+(mkhint) and SBo orphan discovery on the VM over ssh, as background jobs that
+keep running when the GUI disconnects and can be reattached later. A
+dashboard shows VM and repository state, and the GUI can start the VM through
+libvirt when it is off.
+
+Work in progress. See `docs/superpowers/specs/` for the design.
+
+## Requirements
+
+- Desktop: Python 3, PyQt6, ssh access to the VM, optionally `virsh`
+- VM: Python 3.11 or newer, the slackrepo_setup and mkhint tools
+
+## License
+
+Copyright (C) 2026 Danilo M. <danix@danix.xyz>
+
+GPLv2 only. See [LICENSE](LICENSE) for the full text.
+
+## 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.