klipper-dgus-touchscreen/README.md

31 lines
2.1 KiB
Markdown

# DGUSPrinterMenu
DGUS touchscreen firmware for 3D printers running Klipper with support for custom menus.
Requires using a modified version of Klipper, which can be found in [this repository](https://github.com/Desuuuu/klipper/tree/dgus-display).
## Disclaimer
**This software is provided without any warranty. You are solely responsible for your use of it.**
## Compatibility
This firmware is available for the following models of touchscreen:
* T5UID1, 480x272 resolution
## Prerequisites
You have to use this [modified version of Klipper](https://github.com/Desuuuu/klipper/tree/dgus-display).
Please refer to the [Configuration reference](https://github.com/Desuuuu/klipper/blob/dgus-display/docs/Config_Reference.md#dgus-display-support) for the list of available options.
See the [sample-dgus-display.cfg](https://github.com/Desuuuu/klipper/blob/dgus-display/config/sample-dgus-display.cfg) file for a basic example.
## Installation
Please refer to the [Wiki](https://github.com/Desuuuu/DGUSPrinterMenu/wiki) for detailed installation steps.
## Credits
| Material | Author | Modified | License |
|:------------------------------------------------------------------------------:|:---------------------------------------------------------:|:--------:|:---------------------------------------------------------------------:|
| [Feather icons](https://feathericons.com/) | [Cole Bemis](https://twitter.com/colebemis) | Yes | [MIT](https://github.com/feathericons/feather/blob/master/LICENSE) |
| [3D Printing Line icons](https://www.iconfinder.com/iconsets/3d-printing-line) | [Sam Baines](https://www.iconfinder.com/conceptbaines) | Yes | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode) |
| [Fan icon](https://thenounproject.com/term/fan/1153915/) | [Atif Arshad](https://thenounproject.com/atifarshad/) | Yes | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode) |