From 1d06bbf7addcfdb4b3f629d5ee48f85eb43628f0 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:07:53 -0400
Subject: [PATCH 01/15] Direct Links -> Link References
---
README.md | 24 ++++++++++++++++++------
1 file changed, 18 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 9f66332..b2c74ed 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,15 @@
# Watchy - Fully Open Source E-Paper Watch
-
+![Preview]
-**Buy Watchy at [Crowd Supply](https://www.crowdsupply.com/sqfmi/watchy) and [Mouser](https://www.mouser.com/ProductDetail/SQFMI/SQFMI-WATCHY-10?qs=DRkmTr78QARN9VSJRzqRxw%3D%3D)!**
+**Buy Watchy at [Crowd Supply] and [Mouser]!**
-[**Watchy Case & Accessories**](https://shop.sqfmi.com)
+[**Watchy Case & Accessories**][Shop]
-Visit [**https://watchy.sqfmi.com**](https://watchy.sqfmi.com) for documentation, hardware design files, and more!
+Visit [**https://watchy.sqfmi.com**][Website] for documentation, hardware design files, and more!
## Setup
-1. In the Arduino IDE Boards Manager, [install support for the ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html).
+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
@@ -19,8 +19,20 @@ Visit [**https://watchy.sqfmi.com**](https://watchy.sqfmi.com) for documentation
* Partition Scheme: "Minimal SPIFFS"
* All Other Settings: leave to default
-You may also have to install the [CP2104 USB to Serial drivers](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) if the port is not automatically detected.
+You may also have to install the [CP2104 USB to Serial drivers][Drivers] if the port is not automatically detected.
### Have Fun! :)
+
+
+[Preview]: https://watchy.sqfmi.com/img/watchy_render.png
+
+[Crowd Supply]: https://www.crowdsupply.com/sqfmi/watchy
+[Mouser]: https://www.mouser.com/ProductDetail/SQFMI/SQFMI-WATCHY-10?qs=DRkmTr78QARN9VSJRzqRxw%3D%3D
+
+[Website]: https://watchy.sqfmi.com
+[Shop]: https://shop.sqfmi.com
+
+[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
From 36120aef8205f0f6cbd7e05d58ec6d122a24f5c0 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:10:56 -0400
Subject: [PATCH 02/15] Formatted Header
---
README.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index b2c74ed..7b3faba 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# Watchy - Fully Open Source E-Paper Watch
+# Watchy
+
+***A Fully Open Source E-Paper Watch***
![Preview]
From 46e92c76799bb9e9a7a778c8889721962e99ec3f Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:18:04 -0400
Subject: [PATCH 03/15] Added Badges
---
README.md | 16 +++++++++++-----
1 file changed, 11 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 7b3faba..a143b28 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,9 @@
-# Watchy
+# Watchy [![Badge License]][License] [![Badge Discord]][Discord] [![Badge CrowdSupply]][CrowdSupply] [![Badge Mouser]][Mouser]
***A Fully Open Source E-Paper Watch***
![Preview]
-**Buy Watchy at [Crowd Supply] and [Mouser]!**
-
[**Watchy Case & Accessories**][Shop]
Visit [**https://watchy.sqfmi.com**][Website] for documentation, hardware design files, and more!
@@ -27,10 +25,18 @@ You may also have to install the [CP2104 USB to Serial drivers][Drivers] if the
+[Badge License]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge
+[Badge Discord]: https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white
+[Badge CrowdSupply]: https://img.shields.io/badge/CrowdSupply-00b2ad?style=for-the-badge&logo=shopify&logoColor=white 'Buy Watchy at Crowd Supply'
+[Badge Mouser]: https://img.shields.io/badge/Mouser-0070bb?style=for-the-badge&logo=shopify&logoColor=white 'Buy Watchy at Mouser'
+
+[CrowdSupply]: https://www.crowdsupply.com/sqfmi/watchy
+[Discord]: https://discord.gg/ZXDegGV8E7
+[License]: LICENSE
+[Mouser]: https://www.mouser.com/ProductDetail/SQFMI/SQFMI-WATCHY-10?qs=DRkmTr78QARN9VSJRzqRxw%3D%3D
+
[Preview]: https://watchy.sqfmi.com/img/watchy_render.png
-[Crowd Supply]: https://www.crowdsupply.com/sqfmi/watchy
-[Mouser]: https://www.mouser.com/ProductDetail/SQFMI/SQFMI-WATCHY-10?qs=DRkmTr78QARN9VSJRzqRxw%3D%3D
[Website]: https://watchy.sqfmi.com
[Shop]: https://shop.sqfmi.com
From 2781cd23e856b7bb89f33913b8f251e3f9372b2a Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:22:24 -0400
Subject: [PATCH 04/15] Added Link Bar
---
README.md | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index a143b28..fa05a77 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,15 @@
***A Fully Open Source E-Paper Watch***
+---
+
+ **⸢ [Website] ⸥**
+ **⸢ [Shop] ⸥**
+
+---
+
![Preview]
-[**Watchy Case & Accessories**][Shop]
-
-Visit [**https://watchy.sqfmi.com**][Website] for documentation, hardware design files, and more!
-
## Setup
1. In the Arduino IDE Boards Manager, [install support for the ESP32][ESP32].
* Arduino > Preferences > Additional Board Manager URLs
From 47dbd1b800fa0273715f8065abbdd02f87577223 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:23:06 -0400
Subject: [PATCH 05/15] Moved Contribute Into Docs Folder
---
CONTRIBUTING.md => Documentation/Contribute.md | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename CONTRIBUTING.md => Documentation/Contribute.md (100%)
diff --git a/CONTRIBUTING.md b/Documentation/Contribute.md
similarity index 100%
rename from CONTRIBUTING.md
rename to Documentation/Contribute.md
From 37225e6a4e1af0b278f14f173e6b24d9a2de2bad Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:23:42 -0400
Subject: [PATCH 06/15] Moved Setup Into Docs Folder
---
Documentation/Setup.md | 12 ++++++++++++
README.md | 11 -----------
2 files changed, 12 insertions(+), 11 deletions(-)
create mode 100644 Documentation/Setup.md
diff --git a/Documentation/Setup.md b/Documentation/Setup.md
new file mode 100644
index 0000000..b5f0a12
--- /dev/null
+++ b/Documentation/Setup.md
@@ -0,0 +1,12 @@
+## 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
diff --git a/README.md b/README.md
index fa05a77..297ac50 100644
--- a/README.md
+++ b/README.md
@@ -11,18 +11,7 @@
![Preview]
-## 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.
### Have Fun! :)
From 3e4e5992454d9069552f077f32b70f686a600203 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:25:04 -0400
Subject: [PATCH 07/15] More Links
---
README.md | 15 +++++++--------
1 file changed, 7 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 297ac50..6628836 100644
--- a/README.md
+++ b/README.md
@@ -6,15 +6,13 @@
**⸢ [Website] ⸥**
**⸢ [Shop] ⸥**
+ **⸢ [Setup] ⸥**
+ **⸢ [Contribute] ⸥**
---
![Preview]
-
-
-### Have Fun! :)
-
[Badge License]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge
@@ -24,14 +22,15 @@
[CrowdSupply]: https://www.crowdsupply.com/sqfmi/watchy
[Discord]: https://discord.gg/ZXDegGV8E7
-[License]: LICENSE
+[Website]: https://watchy.sqfmi.com
[Mouser]: https://www.mouser.com/ProductDetail/SQFMI/SQFMI-WATCHY-10?qs=DRkmTr78QARN9VSJRzqRxw%3D%3D
+[Shop]: https://shop.sqfmi.com
[Preview]: https://watchy.sqfmi.com/img/watchy_render.png
-
-[Website]: https://watchy.sqfmi.com
-[Shop]: https://shop.sqfmi.com
+[Contribute]: Documentation/Contribute.md
+[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
From 39371cf1f63de6c066ded847110faab1874cd9da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:26:51 -0400
Subject: [PATCH 08/15] Adjusted Style
---
README.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/README.md b/README.md
index 6628836..87a9d35 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,23 @@
***A Fully Open Source E-Paper Watch***
+
+
---
+
+
**⸢ [Website] ⸥**
**⸢ [Shop] ⸥**
**⸢ [Setup] ⸥**
**⸢ [Contribute] ⸥**
+
+
---
+
+
![Preview]
From 728c0051648f90e30c0e5b10fb3c601f7437ba3f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:27:43 -0400
Subject: [PATCH 09/15] Adjusted Spacing
---
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 87a9d35..f905b22 100644
--- a/README.md
+++ b/README.md
@@ -8,10 +8,10 @@
- **⸢ [Website] ⸥**
- **⸢ [Shop] ⸥**
- **⸢ [Setup] ⸥**
- **⸢ [Contribute] ⸥**
+ **⸢ [Website] ⸥**
+ **⸢ [Shop] ⸥**
+ **⸢ [Setup] ⸥**
+ **⸢ [Contribute] ⸥**
From 84da3f8c8c4749c907c114d1e9f98c38127bccfd Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:45:02 -0400
Subject: [PATCH 10/15] Formatted Setup
---
Documentation/Setup.md | 59 ++++++++++++++++++++++++++++++++++--------
README.md | 3 ---
2 files changed, 48 insertions(+), 14 deletions(-)
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
-
From 897fa8728b7ca966ef3943928736a0fd80dba523 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:48:06 -0400
Subject: [PATCH 11/15] Added Spacing
---
Documentation/Setup.md | 43 +++++++++++++++++++++++++++++++++++++++++-
1 file changed, 42 insertions(+), 1 deletion(-)
diff --git a/Documentation/Setup.md b/Documentation/Setup.md
index b1827cb..d42f8bc 100644
--- a/Documentation/Setup.md
+++ b/Documentation/Setup.md
@@ -1,49 +1,90 @@
# 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
+[ESP32]: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html
From 43f5177f9cad1b01802ce042610dacc9c0ffee7d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:48:47 -0400
Subject: [PATCH 12/15] Adjusted Style
---
Documentation/Setup.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/Setup.md b/Documentation/Setup.md
index d42f8bc..ef4cd4d 100644
--- a/Documentation/Setup.md
+++ b/Documentation/Setup.md
@@ -1,6 +1,7 @@
-# Setup
+Setup
+
## Board
From b87fe100ac4c1b444251bfef167fb0afbd802dc6 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:56:05 -0400
Subject: [PATCH 13/15] Formatted Contribute.md
---
Documentation/Contribute.md | 31 ++++++++++++++++++++++---------
1 file changed, 22 insertions(+), 9 deletions(-)
diff --git a/Documentation/Contribute.md b/Documentation/Contribute.md
index d194433..c668745 100644
--- a/Documentation/Contribute.md
+++ b/Documentation/Contribute.md
@@ -1,15 +1,28 @@
-# How to contribute
-### Check out the issue tracker
+# How To Contribute
-Search through [Issue tracker](https://github.com/sqfmi/Watchy/issues) for matching topics. It is also recommended to check with current [Pull requests](https://github.com/sqfmi/Watchy/pulls).
+You might want to check out our [![Badge Discord]][Discord]
-### Issue Pull Request
+## Topics
-1. Fork this repo and branch out from `dev`.
-2. Push commits.
-3. Issue pull request.
+It is recommended to first search for **[Issues]** as well as
+**[Pull Requests]** that match your topic before you start.
-## Community
+## Steps
-- [Discord](https://discord.gg/ZXDegGV8E7)
+1. Fork the repository.
+
+2. Branch out from `dev`.
+
+3. Push your commits.
+
+4. Open a pull request.
+
+
+
+
+[Pull Requests]: https://github.com/sqfmi/Watchy/pulls
+[Issues]: https://github.com/sqfmi/Watchy/issues
+
+[Badge Discord]: https://img.shields.io/badge/Discord-7289DA?style=flat&logo=discord&logoColor=white
+[Discord]: https://discord.gg/ZXDegGV8E7
From 1d0b947d7e757e49ab02ef70c6148d96f8a67c99 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 11:56:46 -0400
Subject: [PATCH 14/15] Adjusted Spacing
---
Documentation/Contribute.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/Documentation/Contribute.md b/Documentation/Contribute.md
index c668745..88e97fb 100644
--- a/Documentation/Contribute.md
+++ b/Documentation/Contribute.md
@@ -3,11 +3,15 @@
You might want to check out our [![Badge Discord]][Discord]
+
+
## Topics
It is recommended to first search for **[Issues]** as well as
**[Pull Requests]** that match your topic before you start.
+
+
## Steps
1. Fork the repository.
From 8617e16f01915fbabe7eff19c97f9c39fb127b8d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?=
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Thu, 7 Apr 2022 12:01:54 -0400
Subject: [PATCH 15/15] Fixed Style
---
Documentation/Setup.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/Setup.md b/Documentation/Setup.md
index ef4cd4d..9f89bd6 100644
--- a/Documentation/Setup.md
+++ b/Documentation/Setup.md
@@ -81,7 +81,7 @@ 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].
+also need to install the **[CP2104 USB To Serial Drivers][Drivers]**.