diff --git a/Images/Watchface.png b/Images/Watchface.png new file mode 100644 index 0000000..879b331 Binary files /dev/null and b/Images/Watchface.png differ diff --git a/README-WatchyGSR.md b/README-WatchyGSR.md new file mode 100644 index 0000000..c49385e --- /dev/null +++ b/README-WatchyGSR.md @@ -0,0 +1,30 @@ +![Watchy GSR Face](https://github.com/GuruSR/Watchy_GSR/blob/main/Images/Watchy_GSR.gif) + +This repo's format: + +Bin folder contains the current OTA Bin that you can use a tool to upload with or an OTA Upgrade capable firmware to install the current OTA Bin to the Watchy. + +src folder contains a universal (Arduino & PlatformIO) setup for compilation, instructions on how to get it to compile are in the src folder. + +Needed libraries: Arduino Libraries, ArduinoOTA (included in ESP32 2.0.2), SmallRTC (1.6 or greater, GuruSR), SmallNTP (GuruSR), StableBMA (GuruSR), Olson2POSIX (GuruSR) AND Watchy (1.3.3 or greater) base. + +**NOTES:** +- Watchy uses version 1.0.6 or 2.0.2 (or higher than 2.0.3) of the ESP32 libraries, 2.0.0 won't compile, 2.0.3 causes a boot crash loop, remove them manually and revert back to version 1.0.6 or use 2.0.2 (which seems to have been fixed). + +**WARNING:** +As of Version 1.4.3H, the Compilation Instructions have changed, the GxEPD2 requires a define to be added to the .h file in the Compilation Instructions or the Dark Border will be disabled. + +For instructions on usage of the firmware, see "Usage". + +Below is a layout of the Watchy Connect & the OTA Website (used while online your network) that gives you options to various things. + + +![OTA Website](https://github.com/GuruSR/Watchy_GSR/blob/main/Images/Server-Help.png) + +OTA update is **ONLY** possible via an OTA compatible firmware which are: + +`Watchy GSR` and those overriding it. + +**If you have an OTA upload function in your firmware, ask for it to be added here.** + +For those wanting to override the looks of this Watchy face, look at the Override Information. diff --git a/README.md b/README.md index c49385e..beceb1e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,9 @@ -![Watchy GSR Face](https://github.com/GuruSR/Watchy_GSR/blob/main/Images/Watchy_GSR.gif) +# My Watchy Watchface -This repo's format: +Custom watchface with calendar, step history, moon phase and more. +It is based off a Watchy by someone anonymous on a certain technology board. -Bin folder contains the current OTA Bin that you can use a tool to upload with or an OTA Upgrade capable firmware to install the current OTA Bin to the Watchy. +The original photo is lost media sadly, +and my Watchy suffered ESD damage so it isn't working. -src folder contains a universal (Arduino & PlatformIO) setup for compilation, instructions on how to get it to compile are in the src folder. - -Needed libraries: Arduino Libraries, ArduinoOTA (included in ESP32 2.0.2), SmallRTC (1.6 or greater, GuruSR), SmallNTP (GuruSR), StableBMA (GuruSR), Olson2POSIX (GuruSR) AND Watchy (1.3.3 or greater) base. - -**NOTES:** -- Watchy uses version 1.0.6 or 2.0.2 (or higher than 2.0.3) of the ESP32 libraries, 2.0.0 won't compile, 2.0.3 causes a boot crash loop, remove them manually and revert back to version 1.0.6 or use 2.0.2 (which seems to have been fixed). - -**WARNING:** -As of Version 1.4.3H, the Compilation Instructions have changed, the GxEPD2 requires a define to be added to the .h file in the Compilation Instructions or the Dark Border will be disabled. - -For instructions on usage of the firmware, see "Usage". - -Below is a layout of the Watchy Connect & the OTA Website (used while online your network) that gives you options to various things. - - -![OTA Website](https://github.com/GuruSR/Watchy_GSR/blob/main/Images/Server-Help.png) - -OTA update is **ONLY** possible via an OTA compatible firmware which are: - -`Watchy GSR` and those overriding it. - -**If you have an OTA upload function in your firmware, ask for it to be added here.** - -For those wanting to override the looks of this Watchy face, look at the Override Information. +![Screenshot of the last simulator build to get a rough idea](Images/Watchface.png) diff --git a/src/readme.md b/src/README-WatchyGSR.md similarity index 100% rename from src/readme.md rename to src/README-WatchyGSR.md