aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: ad784a20477586c72b6223865002156ff30ebe76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Kutter

Kutter is a fork of Klipper.

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.

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.

The project deviates from upstream klipper at commit
e1176e4dfb9018e712d4fa86daf41e9e762a1698. Upstream changes may be
re-incorporated into this fork.

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.