From 2ba7bee5644d0dc0c83117fa797cd5421b14a6aa Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sat, 9 Apr 2022 12:14:28 -0400 Subject: [PATCH 1/7] Direct Links -> Link References --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 53 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 96985a9cb..c8dc61a57 100755 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ # GUIslice library # -[![Build Status](https://travis-ci.org/ImpulseAdventure/GUIslice.svg?branch=master)](https://travis-ci.org/ImpulseAdventure/GUIslice) -[![GitHub Issues](https://img.shields.io/github/issues/ImpulseAdventure/GUIslice.svg)](https://github.com/ImpulseAdventure/GUIslice/issues) -![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg) -[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) +[![Badge Build]][Travis] +[![Badge Issues]][Issues] +[![Badge Contributions]][#] +[![Badge License]][License] *A lightweight GUI framework for embedded displays* Design your GUI with a **drag & drop builder**, then apply the same code to a wide range of displays, libraries and controllers with the **cross-platform framework**. Open source **MIT license** grants free commercial usage. -![Example 1](http://www.impulseadventure.com/elec/images/sdl_menu1.png) -![Example 5](http://www.impulseadventure.com/elec/images/guislice-ctrl2.png) -![GUIslice Builder](https://user-images.githubusercontent.com/8510097/90728338-9a8be100-e279-11ea-969e-cbd8bb0ac6c6.png) +![Example 1] +![Example 5] +![Preview] -- Extensive [Documentation](https://github.com/ImpulseAdventure/GUIslice/wiki) guides available -- [GUIslice API documentation (online)](https://impulseadventure.github.io/GUIslice/modules.html) & [(PDF)](https://github.com/ImpulseAdventure/GUIslice/raw/master/docs/GUIslice_ref.pdf) -- Active development: see [latest updates & work in progress](https://github.com/ImpulseAdventure/GUIslice/issues/85) -- [Release history](https://github.com/ImpulseAdventure/GUIslice/releases) -- [Website (www.impulseadventure.com)](https://www.impulseadventure.com/elec/guislice-gui.html) +- Extensive [Documentation] guides available +- [GUIslice API documentation (online)][API] & [(PDF)][PDF] +- Active development: see [latest updates & work in progress][Latest] +- [Release history][Releases] +- [Website (www.impulseadventure.com)][Website] - **Support email**: guislice@gmail.com -- GUIslice by Calvin Hass and [GitHub contributors](https://github.com/ImpulseAdventure/GUIslice/graphs/contributors), Builder by Paul Conti +- GUIslice by Calvin Hass and [GitHub contributors][Contributors], Builder by Paul Conti ## Features ## - Pure C library, no dynamic memory allocation @@ -43,13 +43,49 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi - GPIO / pin / keyboard / Adafruit Seesaw navigation for non-touchscreen devices ## Screenshots ## -![Example 3](http://www.impulseadventure.com/elec/images/guislice-ex06.png) -![Example 4](http://www.impulseadventure.com/elec/images/guislice-ex08.png) -![snap07_c](https://user-images.githubusercontent.com/8510097/48299251-733a9a00-e47f-11e8-87ac-e35be6ba41d1.png) +![Example 3] +![Example 4] +![Example 2] ## GUIslice Builder ## - Includes cross-platform (Windows, LINUX and Mac) desktop application to generate GUIslice layouts -- Please refer to [GUIslice Builder wiki](https://github.com/ImpulseAdventure/GUIslice/wiki/GUIslice-Builder) for documentation +- Please refer to [GUIslice Builder wiki][Builder] for documentation ## Disclaimer ## The Software is not designed for use in devices or situations where there may be physical injury if the Software has errors. + + + + +[Badge Contributions]: https://img.shields.io/badge/contributions-welcome-orange.svg +[Badge License]: https://img.shields.io/badge/license-MIT-blue.svg +[Badge Issues]: https://img.shields.io/github/issues/ImpulseAdventure/GUIslice.svg +[Badge Build]: https://travis-ci.org/ImpulseAdventure/GUIslice.svg?branch=master + + + + +[License]: LICENSE + +[Documentation]: https://github.com/ImpulseAdventure/GUIslice/wiki +[Contributors]: https://github.com/ImpulseAdventure/GUIslice/graphs/contributors +[Builder]: https://github.com/ImpulseAdventure/GUIslice/wiki/GUIslice-Builder +[Release]: https://github.com/ImpulseAdventure/GUIslice/releases +[Latest]: https://github.com/ImpulseAdventure/GUIslice/issues/85 +[Issues]: https://github.com/ImpulseAdventure/GUIslice/issues +[PDF]: https://github.com/ImpulseAdventure/GUIslice/raw/master/docs/GUIslice_ref.pdf + +[Website]: https://www.impulseadventure.com/elec/guislice-gui.html +[Travis]: https://travis-ci.org/ImpulseAdventure/GUIslice +[API]: https://impulseadventure.github.io/GUIslice/modules.html + + + + +[Example 5]: https://www.impulseadventure.com/elec/images/guislice-ctrl2.png +[Example 4]: https://www.impulseadventure.com/elec/images/guislice-ex08.png +[Example 3]: https://www.impulseadventure.com/elec/images/guislice-ex06.png +[Example 1]: https://www.impulseadventure.com/elec/images/sdl_menu1.png +[Example 2]: https://user-images.githubusercontent.com/8510097/48299251-733a9a00-e47f-11e8-87ac-e35be6ba41d1.png + +[Preview]: https://user-images.githubusercontent.com/8510097/90728338-9a8be100-e279-11ea-969e-cbd8bb0ac6c6.png From 22a1daf39d38e251ebd7be2d1fd75a4fa753b103 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sat, 9 Apr 2022 12:21:56 -0400 Subject: [PATCH 2/7] Adjusted Header --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c8dc61a57..852102c42 100755 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ -# GUIslice library # + +

+ +GUIslice  +[![Badge Contributions]](#)  +[![Badge License]][License]  +[![Badge Issues]][Issues]  [![Badge Build]][Travis] -[![Badge Issues]][Issues] -[![Badge Contributions]][#] -[![Badge License]][License] -*A lightweight GUI framework for embedded displays* +

+ +*A lightweight framework for embedded displays* Design your GUI with a **drag & drop builder**, then apply the same code to a wide range of displays, libraries and controllers with the **cross-platform framework**. Open source **MIT license** grants free commercial usage. From 11a58fa12d831b1a199707b56f3661f648277515 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sat, 9 Apr 2022 12:23:27 -0400 Subject: [PATCH 3/7] Adjusted Screenshot Section --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 852102c42..4117048f5 100755 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi - **Support email**: guislice@gmail.com - GUIslice by Calvin Hass and [GitHub contributors][Contributors], Builder by Paul Conti -## Features ## +## Features - Pure C library, no dynamic memory allocation - *Widgets*: - text, images, buttons, checkboxes, radio buttons, sliders, custom keypads, listbox, @@ -47,16 +47,22 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi - Dynamic display rotation - GPIO / pin / keyboard / Adafruit Seesaw navigation for non-touchscreen devices -## Screenshots ## + +
+ +## Screenshots + ![Example 3] ![Example 4] ![Example 2] -## GUIslice Builder ## +
+ +## GUIslice Builder - Includes cross-platform (Windows, LINUX and Mac) desktop application to generate GUIslice layouts - Please refer to [GUIslice Builder wiki][Builder] for documentation -## Disclaimer ## +## Disclaimer The Software is not designed for use in devices or situations where there may be physical injury if the Software has errors. From f57e1a3f277f1b9479965e99d77291d172d82945 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sat, 9 Apr 2022 12:24:06 -0400 Subject: [PATCH 4/7] Adjusted Example Section --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 4117048f5..75ccb7203 100755 --- a/README.md +++ b/README.md @@ -13,10 +13,14 @@ GUIslice  Design your GUI with a **drag & drop builder**, then apply the same code to a wide range of displays, libraries and controllers with the **cross-platform framework**. Open source **MIT license** grants free commercial usage. +
+ ![Example 1] ![Example 5] ![Preview] +
+ - Extensive [Documentation] guides available - [GUIslice API documentation (online)][API] & [(PDF)][PDF] - Active development: see [latest updates & work in progress][Latest] From 71fa0c06ef2736a8e8b92cd0dd38cdbd64cdf4af 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: Sat, 9 Apr 2022 12:26:57 -0400 Subject: [PATCH 5/7] Adjusted Spacing --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 75ccb7203..4794af878 100755 --- a/README.md +++ b/README.md @@ -11,8 +11,12 @@ GUIslice  *A lightweight framework for embedded displays* +
+ Design your GUI with a **drag & drop builder**, then apply the same code to a wide range of displays, libraries and controllers with the **cross-platform framework**. Open source **MIT license** grants free commercial usage. +
+
![Example 1] @@ -21,6 +25,8 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi
+
+ - Extensive [Documentation] guides available - [GUIslice API documentation (online)][API] & [(PDF)][PDF] - Active development: see [latest updates & work in progress][Latest] @@ -29,6 +35,12 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi - **Support email**: guislice@gmail.com - GUIslice by Calvin Hass and [GitHub contributors][Contributors], Builder by Paul Conti +
+ +--- + +
+ ## Features - Pure C library, no dynamic memory allocation - *Widgets*: @@ -51,6 +63,11 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi - Dynamic display rotation - GPIO / pin / keyboard / Adafruit Seesaw navigation for non-touchscreen devices +
+ +--- + +
@@ -62,13 +79,27 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi
+
+ +--- + +
+ ## GUIslice Builder - Includes cross-platform (Windows, LINUX and Mac) desktop application to generate GUIslice layouts - Please refer to [GUIslice Builder wiki][Builder] for documentation +
+ +--- + +
+ ## Disclaimer The Software is not designed for use in devices or situations where there may be physical injury if the Software has errors. +
+ From 95fd0d3567cc7fbdb1017d18307cecc53780d919 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 4 Aug 2022 03:23:23 -0400 Subject: [PATCH 6/7] Formatted README --- README.md | 200 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 151 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 4794af878..14a9cf68d 100755 --- a/README.md +++ b/README.md @@ -1,23 +1,30 @@ -

+
+ +
-GUIslice  -[![Badge Contributions]](#)  -[![Badge License]][License]  -[![Badge Issues]][Issues]  +[![Badge Contributions]][#]    +[![Badge License]][License]    +[![Badge Issues]][Issues]    [![Badge Build]][Travis] -

+
+ +# GUIslice *A lightweight framework for embedded displays* +

-Design your GUI with a **drag & drop builder**, then apply the same code to a wide range of displays, libraries and controllers with the **cross-platform framework**. Open source **MIT license** grants free commercial usage. +Design your GUI with a **drag & drop builder**, then apply
+the same code to a wide range of displays, libraries and
+controllers with the **cross-platform framework**. -
+Open source **MIT license** grants free commercial usage. -
+
+
![Example 1] ![Example 5] @@ -25,6 +32,7 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi
+

- Extensive [Documentation] guides available @@ -36,43 +44,135 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi - GUIslice by Calvin Hass and [GitHub contributors][Contributors], Builder by Paul Conti
+
+ +## Features + +- Pure C library, no dynamic memory allocation ---- +- Cross-platform **GUIslice Builder**
+ application to generate layouts + +- IDE Support + + GUIslice has been tested for use in the *Arduino IDE*
+ and *Platform IO* environments, in addition to LINUX make + +- Foreign characters / UTF-8 encoding (in SDL mode),
+ anti-aliased fonts (in TFT_eSPI mode) + +- Dynamic display rotation + +- GPIO / pin / keyboard / Adafruit Seesaw
+ navigation for non-touchscreen devices
-## Features -- Pure C library, no dynamic memory allocation -- *Widgets*: - - text, images, buttons, checkboxes, radio buttons, sliders, custom keypads, listbox, - radial controls, scrolling textbox / terminal, graphs, etc. plus extensions and multiple pages. -- Cross-platform **GUIslice Builder** application to generate layouts -- *Platform-independent* GUI core currently supports: - - Adafruit-GFX, TFT_eSPI, mcufriend, UTFT, LCDGFX, SDL1.2, SDL2.0 -- *Devices*: - - Raspberry Pi, Arduino, ATmega2560, ESP8266 / NodeMCU, ESP32, M5stack, Teensy 3 / T4, WIO Terminal, Feather M0 (Cortex-M0), nRF52 (Cortex-M4F), LINUX, Beaglebone Black, STM32, Due, etc. -- *Typical displays*: - - PiTFT, Adafruit TFT 3.5" / 2.8" / 2.4" / 2.2" / 1.44", FeatherWing TFT, OLED 0.96", mcufriend, BuyDisplay / EastRising 4.3" 5" 7", Waveshare, 4D Cape -- *Display drivers include*: - - ILI9341, ST7735, SSD1306, HX8347D, HX8357, PCD8544, RA8875, RA8876, ILI9225, ILI9341_t3, ILI9341_due -- *Touchscreen control including*: - - STMPE610, FT6206, FT5206, XPT2046, 4-wire, tslib, URTouch, Adafruit Seesaw -- *IDE Support*: - - GUIslice has been tested for use in the *Arduino IDE* and *Platform IO* environments, in addition to LINUX make -- Foreign characters / UTF-8 encoding (in SDL mode), anti-aliased fonts (in TFT_eSPI mode) -- Dynamic display rotation -- GPIO / pin / keyboard / Adafruit Seesaw navigation for non-touchscreen devices +### Widgets + +  Scrolling Textbox / Terminal     +  Radial Controls     +  Custom Keypads     + +  Multiple Pages     +  Extensions     +  Checkboxes     +  Listbox     +  Text     + +  Buttons     +  Images     +  Radio Buttons     +  Graphs     + +
+ +### Platform-independent GUI Cores + +  Adafruit-GFX     +  TFT_eSPI     +  mcufriend   + +  LCDGFX     +  UTFT     +  SDL1.2     +  SDL2.0     + +
+ +### Devices + +  ESP8266 / NodeMCU        +  Raspberry Pi        +  ATmega2560      +  M5stack      + +  Feather M0 (Cortex-M0)     +  Beaglebone Black     +  ESP32     +  LINUX     +  nRF52 (Cortex-M4F)     +  Teensy 3 / T4     +  WIO Terminal     +  STM32     + +  Arduino     +  Due   +
---- +### Typical Displays + +  PiTFT     +  Adafruit TFT 3.5" / 2.8" / 2.4" / 2.2" / 1.44"   + +  Waveshare     +  4D Cape     +  FeatherWing TFT     +  OLED 0.96"   + +  mcufriend     +  BuyDisplay / EastRising 4.3" 5" 7"    
+### Display Drivers + +  ILI9341     +  ST7735     +  SSD1306     +  HX8347D     +  HX8357     +  PCD8544   + +  RA8875     +  RA8876     +  ILI9225     +  ILI9341_t3     +  ILI9341_due   + +### Touchscreen Controls + +  4-wire     +  tslib     +  URTouch     +  Adafruit Seesaw   + +  STMPE610     +  FT6206     +  FT5206     +  XPT2046   + +
+
+
## Screenshots +
+ ![Example 3] ![Example 4] ![Example 2] @@ -80,43 +180,34 @@ Design your GUI with a **drag & drop builder**, then apply the same code to a wi

- ---- -
## GUIslice Builder -- Includes cross-platform (Windows, LINUX and Mac) desktop application to generate GUIslice layouts -- Please refer to [GUIslice Builder wiki][Builder] for documentation -
+- Includes cross-platform (Windows, LINUX and Mac)
+ desktop application to generate GUIslice layouts ---- +- Please refer to [GUIslice Builder wiki][Builder] for documentation +

## Disclaimer -The Software is not designed for use in devices or situations where there may be physical injury if the Software has errors. -
+The Software is not designed for use in devices or situations
+where there may be physical injury if the Software has errors. +
- -[Badge Contributions]: https://img.shields.io/badge/contributions-welcome-orange.svg -[Badge License]: https://img.shields.io/badge/license-MIT-blue.svg -[Badge Issues]: https://img.shields.io/github/issues/ImpulseAdventure/GUIslice.svg -[Badge Build]: https://travis-ci.org/ImpulseAdventure/GUIslice.svg?branch=master -[License]: LICENSE - [Documentation]: https://github.com/ImpulseAdventure/GUIslice/wiki [Contributors]: https://github.com/ImpulseAdventure/GUIslice/graphs/contributors +[Releases]: https://github.com/ImpulseAdventure/GUIslice/releases [Builder]: https://github.com/ImpulseAdventure/GUIslice/wiki/GUIslice-Builder -[Release]: https://github.com/ImpulseAdventure/GUIslice/releases [Latest]: https://github.com/ImpulseAdventure/GUIslice/issues/85 [Issues]: https://github.com/ImpulseAdventure/GUIslice/issues [PDF]: https://github.com/ImpulseAdventure/GUIslice/raw/master/docs/GUIslice_ref.pdf @@ -125,6 +216,8 @@ The Software is not designed for use in devices or situations where there may be [Travis]: https://travis-ci.org/ImpulseAdventure/GUIslice [API]: https://impulseadventure.github.io/GUIslice/modules.html +[License]: LICENSE +[#]: # @@ -135,3 +228,12 @@ The Software is not designed for use in devices or situations where there may be [Example 2]: https://user-images.githubusercontent.com/8510097/48299251-733a9a00-e47f-11e8-87ac-e35be6ba41d1.png [Preview]: https://user-images.githubusercontent.com/8510097/90728338-9a8be100-e279-11ea-969e-cbd8bb0ac6c6.png + + + + +[Badge Contributions]: https://img.shields.io/badge/Contributions-Welcome-067a35.svg?style=for-the-badge&labelColor=0ABF53 +[Badge License]: https://img.shields.io/badge/License-MIT-ac8b11.svg?style=for-the-badge&labelColor=yellow +[Badge Issues]: https://img.shields.io/github/issues/ImpulseAdventure/GUIslice.svg?style=for-the-badge&labelColor=1B72BE&color=13538b +[Badge Build]: https://img.shields.io/travis/ImpulseAdventure/GUIslice?style=for-the-badge&labelColor=EF2D5E&color=b11d42 + From 84f64358b2f4187ae86651631c2941bffd4411d0 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 4 Aug 2022 03:24:22 -0400 Subject: [PATCH 7/7] Adjusted Spacing --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 14a9cf68d..415bdc908 100755 --- a/README.md +++ b/README.md @@ -152,6 +152,8 @@ Open source **MIT license** grants free commercial usage.   ILI9341_t3       ILI9341_due   +
+ ### Touchscreen Controls   4-wire