docs: README mit Patch-Übersicht + Lizenz-/Quell-Hinweis

2026-05-23 12:00:19 +02:00
parent 7205a8ab83
commit 60e2ef7012
1 changed files with 78 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,80 @@
+<div align="center">
+
 # OrcaSlicer-KX

-OrcaSlicer builds with extra Anycubic Kobra X patches (AGPL-3.0, based on SoftFever/OrcaSlicer)
+**OrcaSlicer builds with extra Anycubic Kobra X patches**
+
+Pre-built [OrcaSlicer](https://github.com/SoftFever/OrcaSlicer) binaries that bundle
+in-progress PRs improving Kobra X support — recommended for use with [KX-Bridge](https://gitea.it-drui.de/viewit/KX-Bridge-Release).
+
+[![Download](https://img.shields.io/badge/Download-Releases-2EA043?style=for-the-badge&logo=gitea&logoColor=white)](https://gitea.it-drui.de/viewit/OrcaSlicer-KX/releases)
+&nbsp;
+[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/agpl-3.0)
+
+</div>
+
+---
+
+## What's inside
+
+Standard OrcaSlicer (v2.4.0-dev) with these **additional PRs from SoftFever/OrcaSlicer**
+applied on top:
+
+- **[PR #13372](https://github.com/SoftFever/OrcaSlicer/pull/13372)** — Moonraker Happy Hare AMS Sync Fix
+  (filament sync now keeps the slot positions intact even with empty slots)
+- **[PR #13529](https://github.com/SoftFever/OrcaSlicer/pull/13529)** — Anycubic Kobra X full printer profile
+- **[PR #13677](https://github.com/SoftFever/OrcaSlicer/pull/13677)** — Kobra X multicolor G-code fix
+
+For most users the AMS-related fix (#13372) is the practical reason to use this
+build over upstream OrcaSlicer: with an empty slot in the middle of the AMS,
+upstream shifts the colors onto the wrong positions during filament sync.
+
+---
+
+## Downloads
+
+Get the latest binaries from the [Releases page](https://gitea.it-drui.de/viewit/OrcaSlicer-KX/releases):
+
+- **Linux:** `OrcaSlicer_Linux_V2.4.0-dev.AppImage` — `chmod +x` and run.
+- **Windows:** `OrcaSlicer-Windows-x64.zip` — extract and run `OrcaSlicer.exe`.
+
+Checksums in `SHA256SUMS.txt`. macOS is not provided here — build from upstream.
+
+> ⚠ This is a **pre-release dev build** (OrcaSlicer 2.4.0-dev). Use at your own risk.
+> For a stable release, use upstream OrcaSlicer.
+
+---
+
+## Why a separate repo?
+
+KX-Bridge itself (the GPLv3 Moonraker bridge for the Kobra X) is hosted at
+[viewit/KX-Bridge-Release](https://gitea.it-drui.de/viewit/KX-Bridge-Release).
+OrcaSlicer is a different project under a different license (AGPL-3.0) — kept
+separate so licenses, source provenance and update cycles don't get tangled.
+
+---
+
+## License & source
+
+These builds are derivatives of [OrcaSlicer](https://github.com/SoftFever/OrcaSlicer),
+licensed under **GNU AGPL-3.0**. All rights to the upstream OrcaSlicer code and to
+the linked PRs remain with their respective authors. Sources are available via:
+
+- Upstream: <https://github.com/SoftFever/OrcaSlicer>
+- The three additional PRs linked above (#13372 / #13529 / #13677)
+
+No upstream code is mirrored in this repo — this repo only hosts the built
+binaries. If you need the exact source state used for a build, take upstream
+OrcaSlicer at the build's commit and apply the listed PRs.
+
+---
+
+## Rebuild workflow
+
+When upstream or one of the PRs changes:
+
+1. In a clean OrcaSlicer checkout: rebase on `SoftFever/OrcaSlicer:main`,
+   cherry-pick or merge the three PR branches.
+2. Build Linux AppImage and Windows ZIP.
+3. New release tag `v<upstream-version>-kx<N>` (e.g. `v2.4.1-kx1`).
+4. Re-upload assets with `SHA256SUMS.txt`.