From 8573b3d5c4b0deb95e467eb235b6d1ad0e97fff2 Mon Sep 17 00:00:00 2001 From: Patrick Balsiger Date: Thu, 29 Nov 2018 19:17:26 +0100 Subject: [PATCH] some nice intro text --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d59cc85..d8a547d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Illumination-Cat -This is the brain of the the almighty Illumination-Cat. +The Illumination-Cat (short IlluCat) is the collaborative work of several streams, ranging from 3D modeling, electronics and programming. +Originating from the Chaos-Drucker Club with the idea of having +a cool status indicator for 3D printers, the project grew beyond the original idea. + +From the software point of view, the IlluCat is the exemplary model of the [Sprocket framework](https://gitlab.com/wirelos/sprocket-lib), implementing the various aspects and possibilities of the framework. +IlluCat can embed several plugins, like web interface, MQTT, IRC or even mesh networking. +As the framework supports easy integration of many available Arduino libraries, IlluCat can be easily customized to your needs. This repository contains some example implementations that you can use to build your own custom cat. ## OTA pio run -e build && \ @@ -11,4 +17,5 @@ curl -X POST http://illucat.lan/restart [Installation](https://gitlab.com/0x1d/illucat/blob/master/installation.md) [API](https://gitlab.com/0x1d/illucat/blob/master/api.md) [OctoPrint Stuff](https://github.com/FrYakaTKoP/simple-octo-ws2812) - +[Sprocket framework](https://gitlab.com/wirelos/sprocket-lib) +[Sprocket plugins](https://gitlab.com/wirelos)