diff --git a/Documentation/Setup.md b/Documentation/Setup.md index b5f0a12..b1827cb 100644 --- a/Documentation/Setup.md +++ b/Documentation/Setup.md @@ -1,12 +1,49 @@ -## Setup -1. In the Arduino IDE Boards Manager, [install support for the ESP32][ESP32]. - * Arduino > Preferences > Additional Board Manager URLs - * ```https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json``` -2. Install this library (search for **Watchy** in the library manager), and any other dependencies when prompted -3. Check out the examples under ```Examples``` -> ```Watchy``` -4. Compile & Upload with these board settings: - * Board: "ESP32 Dev Module" - * Partition Scheme: "Minimal SPIFFS" - * All Other Settings: leave to default -You may also have to install the [CP2104 USB to Serial drivers][Drivers] if the port is not automatically detected. \ No newline at end of file +# Setup + +## Board + +In the **Arduino IDE Boards Manager** you will
+need to **[Install Support][ESP32]** for the **ESP32** board. + +##### Navigate To + +**Arduino** **›** **Preferences** **›** **Additional Board Manager URLs** + +##### Insert + +``` +https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json +``` + +## Library + +In the **Library Manager**, search for `Watchy`
+and install it and any of its dependencies. + +## Example + +Check out the examples under + +**Examples** **›** **Watchy** + +## Compile / Upload + +Use the following settings when building
+and leave any other ones at their default. + +Setting | | +:------:|:------:| +Board | `ESP Dev Module` +Partition Scheme | `Minimal SPIFFS` + +## Port + +In case your port isn't automatically detected, you may
+also need to install the [CP2104 USB To Serial Drivers][Drivers]. + + + + +[Drivers]: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers +[ESP32]: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html \ No newline at end of file diff --git a/README.md b/README.md index f905b22..9c814e5 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,3 @@ [Setup]: Documentation/Setup.md [License]: LICENSE -[Drivers]: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers -[ESP32]: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html -