diff --git a/README.md b/README.md
index cf4ce23b..862f4f5b 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,10 @@
# HASP - Open Hardware edition
-This is a re-implementation of the popular HASwitchPlate sketch created by aderusha.
+This project is a re-implementation of the popular HASwitchPlate sketch created by aderusha.
The [original HASwitchPlate][1] project uses a Wemos D1 mini and requires a Nextion/TJC HMI display.
This rewrite removes the Nextion/TJC requirement by using the [Littlev Graphics Library][2] on the MCU to drive a cheap commodity display.
This version also adds ESP32 support to take advantage of the additional hardware capabilities.
-[1]: https://github.com/aderusha/HASwitchPlate
-[2]: https://github.com/littlevgl/lvgl
## Demo Screens
@@ -14,20 +12,20 @@ This version also adds ESP32 support to take advantage of the additional hardwar
## Features
-| Feature | ESP8266 | ESP32
-|--------------------|---------|---------
-| SPI display |
- - [x] yes
| - - [x] yes
-| Parallel display | - - [ ] no
| *tbd*
-| PWM Screen dimming | - - [x] yes
| - - [x] yes
-| Maximum Page Count | 4 | 12
-| Object Types / Widgets | 14 | 15
-| Dynamic Objects | - - [x] yes
| - - [x] yes
-| Lvgl Theme Support | basic only | all themes
-| Custom .zi V5 font | - - [x] yes
| - - [x] yes
-| FontAwesome Icons | - - [x] 1300+
| - - [x] 1300+
-| PNG images | - - [ ] no
| *tbd*
+| Feature | ESP8266 | ESP32
+|-------------------------|---------|---------
+| SPI display | - - [x] yes
| - - [x] yes
+| Parallel display | - - [ ] no
| *tbd*
+| PWM Screen dimming | - - [x] yes
| - - [x] yes
+| Maximum Page Count | 4 | 12
+| Object Types / Widgets | 14 | 15
+| Dynamic Objects | - - [x] yes
| - - [x] yes
+| [Lvgl Theme Support][3] | basic only | all themes
+| [Custom .zi V5 font][4] | - - [x] yes (latin1)
| - - [x] yes (latin1)
+| [FontAwesome Icons][5] | - - [x] 1300+
| - - [x] 1300+
+| PNG images | - - [ ] no
| *tbd*
-# Cloning
+## Cloning
Make sure to add the `--recursive` parameter when cloning the project. Otherwise git will not download the required submodules in the `/lib` subdirectory.
@@ -44,3 +42,9 @@ git submodule update --init --recursive
## Getting Started
Check out the [wiki](https://github.com/fvanroie/hasp-lvgl/wiki) for how-to's, information and frequently asked questions.
+
+[1]: https://github.com/aderusha/HASwitchPlate
+[2]: https://github.com/littlevgl/lvgl
+[3]: https://littlevgl.com/themes
+[4]: https://github.com/fvanroie/HMI-Font-Pack/releases
+[5]: https://fontawesome.com/cheatsheet/