2021-09-17 20:38:24 +02:00
|
|
|
|
# [ℹ️ New version available for testing](https://github.com/Desuuuu/klipper/discussions/74)
|
|
|
|
|
|
2016-05-25 17:37:40 +02:00
|
|
|
|
Welcome to the Klipper project!
|
|
|
|
|
|
2019-04-20 19:40:24 +02:00
|
|
|
|
[![Klipper](docs/img/klipper-logo-small.png)](https://www.klipper3d.org/)
|
2016-05-25 17:37:40 +02:00
|
|
|
|
|
2019-04-20 19:40:24 +02:00
|
|
|
|
https://www.klipper3d.org/
|
2016-12-21 04:22:54 +01:00
|
|
|
|
|
2019-04-20 19:40:24 +02:00
|
|
|
|
Klipper is a 3d-Printer firmware. 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 Klipper.
|
2016-05-25 17:37:40 +02:00
|
|
|
|
|
2019-04-20 19:40:24 +02:00
|
|
|
|
To begin using Klipper start by
|
|
|
|
|
[installing](https://www.klipper3d.org/Installation.html) it.
|
2016-05-25 17:37:40 +02:00
|
|
|
|
|
2019-04-20 19:40:24 +02:00
|
|
|
|
Klipper is Free Software. See the [license](COPYING) or read the
|
2022-07-12 23:42:48 +02:00
|
|
|
|
[documentation](https://www.klipper3d.org/Overview.html). We depend on
|
|
|
|
|
the generous support from our
|
|
|
|
|
[sponsors](https://www.klipper3d.org/Sponsors.html).
|
2020-08-16 14:51:53 +02:00
|
|
|
|
|
|
|
|
|
## Modifications
|
|
|
|
|
|
2020-11-21 16:11:05 +01:00
|
|
|
|
The scope of modifications is limited to adding support for DWIN T5UID1
|
2020-11-23 01:29:08 +01:00
|
|
|
|
touchscreens (except for the addition of a `--warn` CLI option, which sets the
|
2020-11-23 00:10:57 +01:00
|
|
|
|
logging level to WARNING).
|
|
|
|
|
|
2021-05-26 19:10:19 +02:00
|
|
|
|
The touchscreen feature is only available for AVR/LPC176X/STM32/SAMD
|
2021-03-06 13:46:02 +01:00
|
|
|
|
micro-controllers and it needs to be configured before compilation.
|
2020-08-16 14:51:53 +02:00
|
|
|
|
|
|
|
|
|
The touchscreen firmware compatible with this fork is available in
|
|
|
|
|
[this repository](https://github.com/Desuuuu/DGUS-reloaded-Klipper).
|
|
|
|
|
|
2020-08-22 19:38:50 +02:00
|
|
|
|
Example configurations are available in
|
|
|
|
|
[this repository](https://github.com/Desuuuu/DGUS-reloaded-Klipper-config).
|
|
|
|
|
|
2020-08-16 14:51:53 +02:00
|
|
|
|
Available configuration options are documented in the
|
|
|
|
|
[sample-t5uid1.cfg](/config/sample-t5uid1.cfg) file.
|