Lixie Labs 6 éve
szülő
commit
93029a2bec
1 módosított fájl, 27 hozzáadás és 1 törlés
  1. 27 1
      README.md

+ 27 - 1
README.md

@@ -1,10 +1,36 @@
+![Lixie II](https://i.imgur.com/G5l9iJk.png)
 <<<<<<< HEAD
 # EDGELIT
 
+# Lixie II for Arduino
 Hey Lixie fans! *This is a work-in-progress library*, please refer to src/Edgelit.h for functions it contains, and stay tuned for updates!
 
+This library is a work-in-progress, but almost all of the functionality from the original Lixie 1/Edgelit libraries is here, and will have software examples within the next day or so! For now, you can [refer to the original library documentation](https://github.com/connornishijima/Lixie-arduino) for its usage is almost identical. Just change any ocurrance of "Lixie" in your code with "Lixie_II".
+
+# WARNING
+
+## UNLIKE THE ORIGINAL LIXIE LIBRARY, THIS ONE RELIES ON THE ESPRESSIF/XTENSA ARCHITECTURE. (ESP8266 / ESP32 - NOT AVR)
+
+This decision was made to allow for non-blocking animation code, as the Ticker library or ESP32's second core are great for this. The vast majority of Lixie 1 users were using Espressif controllers anyways for a cheap gateway for the Lixies to fetch internet time, stocks, analytics, etc. This means that any Arduino Unos, Micros, Pro Minis, Megas, those old controllers are out. This isn't an "Apple killing the headphone jack" moment, for me this was a "Apple retiring the iPod Classic" moment. We have better stuff now, and just like web developers not wanting to hold back potential to make sure a site can run on Internet Explorer, I didn't want to hold back what Lixies were capable of either. The Espressif microcontrollers are amazing, and unless you're going for low-power, (Lixies are not) AVR isn't really right for something like this anymore. Farewell, AVR architecture. 
+
+----------
+# Installation
+
+***The Lixie library relies on [the FastLED library from Daniel Garcia](https://github.com/FastLED/FastLED), so make sure you have that installed as well!***
+
+~**With Arduino Library Manager:**~ COMING SOON!
+
+~1. Open *Sketch > Include Library > Manage Libraries* in the Arduino IDE.~
+~2. Search for "Lixie", and select the latest version.~
+~3. Click the Install button and Arduino will prepare the library and examples for you!~
+
+**Manual Install:**
+
+1. Click "Clone or Download" above to get an "Lixie_II-master.zip" file.
+2. Extract its contents to the libraries folder in your Arduino sketchbook. (".../Documents/Arduino/libraries" on Windows)
+3. Rename the folder from "Lixie_II-master" to "Lixie_II".
 More info here:
 [HACKADAY.IO](https://hackaday.io/project/18633-lixie-an-led-alternative-to-the-nixie-tube/log/150072-lixie-is-now-3499-production-updates)
 =======
 Hey Lixie fans! This library is a work in progress, stay tuned for documentation and examples!
->>>>>>> parent of cac07ae... Merge branch 'master' of https://github.com/connornishijima/Edgelit
+>>>>>>> parent of cac07ae... Merge branch 'master' of https://github.com/connornishijima/Edgelit