Quellcode durchsuchen

Update README.md

Lixie Labs vor 6 Jahren
Ursprung
Commit
a8b775c342
1 geänderte Dateien mit 17 neuen und 0 gelöschten Zeilen
  1. 17 0
      README.md

+ 17 - 0
README.md

@@ -7,3 +7,20 @@ This library is a work-in-progress, but almost all of the functionality from the
 ## UNLIKE THE ORIGINAL LIXIE LIBRARY, THIS ONE RELIES ON THE ESPRESSIF 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. (Usually "Documents/Arduino/libraries")
+3. Rename the folder from "Lixie_II-master" to "Lixie_II".