diff options
author | Tomasz Kramkowski <tomasz@kramkow.ski> | 2025-08-15 21:14:06 +0100 |
---|---|---|
committer | Tomasz Kramkowski <tomasz@kramkow.ski> | 2025-08-15 21:46:37 +0100 |
commit | 5cc72c0da7043af9fa5b72af60a701d0162ea82a (patch) | |
tree | 032a816803b210b7ce66ef56dd1719467baf6ff1 | |
parent | ae9102482560b557628c83a247ab35063ade0bf7 (diff) | |
download | kutter-5cc72c0da7043af9fa5b72af60a701d0162ea82a.tar.gz kutter-5cc72c0da7043af9fa5b72af60a701d0162ea82a.tar.xz kutter-5cc72c0da7043af9fa5b72af60a701d0162ea82a.zip |
Rewrite the readme
-rw-r--r-- | README.md | 30 |
1 files changed, 18 insertions, 12 deletions
@@ -1,17 +1,23 @@ -Welcome to the Klipper project! +# Kutter -[](https://www.klipper3d.org/) +Kutter is a fork of Klipper. -https://www.klipper3d.org/ +Klipper is great but is not designed to be packaged and used like a regular +distro package. This fork makes a number of breaking changes to allow Klipper to +be used as a normal distro package and to allow the config to be externally +managed without Klipper overwriting it. -The Klipper firmware controls 3d-Printers. It combines the power of a -general purpose computer with one or more micro-controllers. See the -[features document](https://www.klipper3d.org/Features.html) for more -information on why you should use the Klipper software. +If you don't understand what this means, or why you would want this, or you do +understand what it means but don't want it, then turn back now, this fork has +nothing to offer you. -Start by [installing Klipper software](https://www.klipper3d.org/Installation.html). +The project deviates from upstream klipper at commit +e1176e4dfb9018e712d4fa86daf41e9e762a1698. Upstream changes may be +re-incorporated into this fork. -Klipper software is Free Software. See the [license](COPYING) or read -the [documentation](https://www.klipper3d.org/Overview.html). We -depend on the generous support from our -[sponsors](https://www.klipper3d.org/Sponsors.html). +All changes since the deviation are documented in `CHANGELOG.md`. + +The end goal is to have klipper be a more-or-less normal python package with the +extra step of having a C library. There are no plans to use a cpython extension +module. You would install the package, and separately install the source files +for that version so you can build the MCU code. |