installation instructions for arduino

Author: vroland

README.md

@@ -11,10 +11,12 @@ EPDiy is a driver board which talks to affordable E-Paper (or E-Ink) screens, wh
 
 Ready-made DIY modules for this size and with 4bpp (16 Grayscale) color support are currently quite expensive. This project uses Kindle replacement screens, which are available for 20$ (small) / 30$ (large) on ebay!
 
-The EPDiy driver board targets multiple E-Paper displays. As the driving method for all matrix-based E-ink displays seems to be more or less the same, only the right connector and timings are needed. The EPDiy PCB v4 features a 33pin and a 39pin connector, which allow to drive the following display types: ED097OC4, ED060SC4, ED097TC2. With the upcoming revision v5, even more display types will be supported! For details, refer to the table below.
+The EPDiy driver board targets multiple E-Paper displays. As the driving method for all matrix-based E-ink displays seems to be more or less the same, only the right connector and timings are needed. The EPDiy PCB v5 features 33pin, 34pin and a 39pin connectors, which allow to drive the following display types: ED097OC4, ED060SC4, ED097TC2, ED060SC7. For the full list of supported displays, refer to the table below.
 
 Revision 5 of the board is optimized for the use with LiPo batteries, featuring a LiPo charger and ultra-low deep sleep current.
 
+This project supports a driver for the ESP-IDF and Arduino. For installation instructions, please refer to the [documentation](https://epdiy.readthedocs.io/en/latest/getting_started.html#getting-your-board).
+
 Building It
 -----------
 
@@ -72,9 +74,9 @@ Displays
 |ED060SCP|6"|600 x 800|yes (should work as ED060XC3)|THD0515-34CL-SN|34|V5|Different flex cable shape
 |ED060SC7|6"|600 x 800|yes (should work) |AXT434124|34|v5|
 |ED060SCG|6"|600 x 800|yes (should work) |AXT434124|34|v5|
-|ED060SCE|6"|600 x 800|yes (should work) |AXT434124|34|v5|
-|ED060SCM|6"|600 x 800|yes (should work) |AXT434124|34|v5|
-|ED060SCT|6"|600 x 800|yes (should work) |AXT434124|34|v5|
+| ED060SCE | 6" | 600 x 800 | yes (should work)  | AXT434124 | 34 | v5 |
+| ED060SCM | 6" | 600 x 800 | yes (should work)  | AXT434124 | 34 | v5 |
+| ED060SCT | 6" | 600 x 800 | yes, tested        | AXT434124 | 34 | v5 |
 
 **Please note that board revision v5 is still in prototype stage!**
 

doc/source/getting_started.rst

@@ -127,8 +127,23 @@ to make your code portable.
 Use with Arduino
 ----------------
 
-Support for Arduino is coming soon.
+Epdiy can be used as an Arduino library. Additionally, epdiy comes with board definitions for its supported boards, which must be installed separately. 
+To install epdiy to work with the Arduino IDE (>= 1.8), follow the steps below:
 
-In the meantime, it is possible to use the `Arduino APIs as an IDF component <https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md>`_,
+1. Download / Clone the epdiy repository into your arduino libraries folder.
+2. Install the `arduino-esp32 core <https://github.com/espressif/arduino-esp32#installation-instructions>`_. 
+3. Due to a limitation in the arduino-esp32 core, the epdiy board definitions must be installed manually. To do that, copy the :code:`boards.local.txt` file that comes with epdiy to the directory you installed the esp32 core in.
+
+    * On Linux, this will be somewhere in :code:`~/Arduino/hardware/esp32/esp32`.
+    * On Windows, this will look something like :code:`C:/Users/<username>/Documents/Arduino/hardware/espressif/esp32` or a similar path in AppData.
+
+   You can also search the Arduino logs to find the arduino-esp32 install directory.
+
+   If you have the correct directory, there should be a :code:`boards.txt` file in it. Copy the :code:`boards.local.txt` in this directory.
+4. Re-start the Arduino IDE. The Epdiy boards should now show up among the other ESP32 boards.
+5. Select your epdiy-compatible board. You can now select your display from the board menu.
+6. Try out an example sketch! Some of them are not very Arduino-Style yet, but they should help getting you started. 
+
+Alternatively, it is possible to use the `Arduino APIs as an IDF component <https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md>`_,
 which allows you to use the Arduino ecosystem (Except for a different build process).