diff --git a/README.md b/README.md index 6d7c682..050fb52 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,13 @@ -# LED Effects for Klipper +# LED Effects for Klipper (Reemo3dp's Fork) -## Description - -This is the standalone repository of the Klipper LED Effects module developed by [Paul McGowan](https://github.com/mental405) with contributions from myself. -It allows Klipper to run effects and animations on addressable LEDs, such as Neopixels, WS2812 or SK6812. - -Check out Paul's printer: - -[![Hello Friend. -International Edition-](https://i3.ytimg.com/vi/-VpZTDSu1-8/hqdefault.jpg)](https://www.youtube.com/watch?v=-VpZTDSu1-8) - -See the chapter in this video from Vector3D what it can do and how to set it up (start from the beginning to learn how to connect the LEDs): - -[![The 3D Printer Upgrade You didn’t know you needed](https://i3.ytimg.com/vi/14LC8Tcd_JQ/hqdefault.jpg)](https://youtu.be/14LC8Tcd_JQ?t=779) - -And this one (in french) from Tom's Basement: - -[![Klipper LED EFFECTS : C'est Noël avant l'heure dans votre imprimante 3D ! (Tuto Leds)](http://i3.ytimg.com/vi/6rGjlBjFhss/hqdefault.jpg)](https://www.youtube.com/watch?v=6rGjlBjFhss) - -## Disclaimer -**This is work in progress and currently in "alpha" state.** - -If you encounter any problems, feel free to open an issue. - -If you need support or want to help by testing or contributing, please contact me on the [Klipper](https://discord.klipper3d.org/) or [Voron](https://discord.com/channels/460117602945990666/460172848565190667) Discord: Hagbard#7867 +**Attention: This is an experimental fork of *julianschill*'s LED Effect. ## Installation The module can be installed into a existing Klipper installation with an install script. cd ~ - git clone https://github.com/julianschill/klipper-led_effect.git + git clone https://github.com/reemo3dp/klipper-led_effect.git cd klipper-led_effect ./install-led_effect.sh @@ -38,6 +16,5 @@ The module can be installed into a existing Klipper installation with an install Documentation can be found [here](docs/LED_Effect.md). ## Support -If you want to support me, either contribute code or -[![kofi](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=flat-square)](https://ko-fi.com/Hagbard) +Support Julian on Ko-Fi: [![kofi](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=flat-square)](https://ko-fi.com/Hagbard)