diff --git a/README.md b/README.md index 218d9fb..d5ad62a 100755 --- a/README.md +++ b/README.md @@ -1,17 +1,26 @@ # Pervasive Displays Library Suite - Basic Edition - Touch -[![Release](https://img.shields.io/github/v/release/rei-vilo/PDLS_EXT3_Basic_Touch)](https://github.com/rei-vilo/PDLS_EXT3_Basic_Touch/releases) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/79b420dc349245f0b9548255884de41b)](https://app.codacy.com/gh/rei-vilo/PDLS_EXT3_Basic_Touch/dashboard?utm_source=github.com&utm_medium=referral&utm_content=rei-vilo/PDLS_EXT3_Basic_Touch&utm_campaign=Badge_Grade) ![Arduino lint](https://github.com/rei-vilo/PDLS_EXT3_Basic_Touch/actions/workflows/main.yml/badge.svg) [![GitHub issues](https://img.shields.io/github/issues/rei-vilo/PDLS_EXT3_Basic_Global)](https://github.com/rei-vilo/PDLS_EXT3_Basic_Global/issues) [![](https://img.shields.io/badge/-Wiki-orange)](https://docs.pervasivedisplays.com/) [![](https://img.shields.io/badge/-User_Guide-orange)](https://pdls.pervasivedisplays.com/userguide/index.html) [![](https://img.shields.io/badge/-Reference_manual-orange)]( +[![Release](https://img.shields.io/github/v/release/rei-vilo/PDLS_EXT3_Basic_Touch)](https://github.com/rei-vilo/PDLS_EXT3_Basic_Touch/releases) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/79b420dc349245f0b9548255884de41b)](https://app.codacy.com/gh/rei-vilo/PDLS_EXT3_Basic_Touch/dashboard?utm_source=github.com&utm_medium=referral&utm_content=rei-vilo/PDLS_EXT3_Basic_Touch&utm_campaign=Badge_Grade) ![Arduino lint](https://github.com/rei-vilo/PDLS_EXT3_Basic_Touch/actions/workflows/main.yml/badge.svg) [![GitHub issues](https://img.shields.io/github/issues/rei-vilo/PDLS_EXT3_Basic_Global)](https://github.com/rei-vilo/PDLS_EXT3_Basic_Global/issues) +[![](https://img.shields.io/badge/-Wiki-orange)](https://docs.pervasivedisplays.com/) [![](https://img.shields.io/badge/-User_Guide-orange)](https://pdls.pervasivedisplays.com/userguide/index.html) [![](https://img.shields.io/badge/-Reference_manual-orange)]( https://rei-vilo.github.io/PDLS_EXT3_Basic_Documentation/html/index.html) -The Pervasive Displays Library Suite is specifically designed for the [Pervasive Displays](https://www.pervasivedisplays.com) e-paper screens and EXT3 extension board. +The Pervasive Displays Library Suite is specifically designed for the [Pervasive Displays](https://www.pervasivedisplays.com) e-paper screens, extension boards and evaluation kits. ![](https://pdls.pervasivedisplays.com/userguide/img/Logo_PDI_text_320.png) -The **PDLS_EXT3_Basic_Touch** provides a high-level interface to drive the e-paper screens with embedded fast update and capacitive touch: +The **PDLS_EXT3_Basic_Touch** supports the screens -+ [EPD Pico Kit Touch (EPDK-271-Touch)](https://www.pervasivedisplays.com/product/touch-expansion-board-ext3-touch/#tab-3), which includes a Raspberry Pi Pico RP2040, the EXT3-1 and EXT3-Touch extension boards and a 2.71"-Touch monochrome panel with embedded fast update and capacitive touch; or -+ [EPD Extension Kit Gen 3 (EXT3 or EXT3-1)](https://www.pervasivedisplays.com/product/epd-extension-kit-gen-3-EXT3/) and [Touch Expansion Board for EXT3 (EXT3-Touch)](https://www.pervasivedisplays.com/product/touch-expansion-board-ext3-touch/); and -+ iTC [monochrome screens with touch](https://www.pervasivedisplays.com/products/?_sft_etc_itc=tp). ++ iTC [monochrome screens with touch](https://www.pervasivedisplays.com/products/?_sft_etc_itc=tp); + +the boards + ++ [EPD Extension Kit Gen 3 (EXT3 or EXT3-1)](https://www.pervasivedisplays.com/product/epd-extension-kit-gen-3-EXT3/); ++ [E-paper touch display development kit (EXT3-Touch)](https://www.pervasivedisplays.com/product/touch-expansion-board-ext3-touch/); + +the kits + ++ [EPD Pico Kit (EPDK)](https://www.pervasivedisplays.com/product/epd-pico-kit-epdk/), which includes a Raspberry Pi Pico RP2040, an EXT3-1 extension board and a 2.66" monochrome panel. ++ [EXT3-Touch with 2.71" Touch EPD (EPDK-271-Touch)](https://www.pervasivedisplays.com/product/touch-expansion-board-ext3-touch/), which includes the EXT3-1 and EXT3-Touch extension boards and a 2.71"-Touch monochrome panel with embedded fast update and capacitive touch. ## Features @@ -22,13 +31,15 @@ The **PDLS_EXT3_Basic_Touch** provides a high-level interface to drive the e-pap + Touch management + GUI with button and text -## Documentation and support +## Documentation + [Wiki](https://docs.pervasivedisplays.com/) + [User guide](https://pdls.pervasivedisplays.com/userguide/index.html) with commented examples + [Reference manual](https://rei-vilo.github.io/PDLS_EXT3_Basic_Documentation/index.html) -+ For support, please refer to [PDLS_EXT3_Basic_Global](https://github.com/rei-vilo/PDLS_EXT3_Basic_Global/issues) for reporting issues and contributing pull requests. +## Support + ++ Please refer to [PDLS_EXT3_Basic_Global](https://github.com/rei-vilo/PDLS_EXT3_Basic_Global/issues) for reporting issues and contributing pull requests. ## Installation @@ -54,8 +65,9 @@ Software Hardware -* Pervasive Displays [EPD Extension Kit Gen 3 (EXT3-1)](https://www.pervasivedisplays.com/product/epd-extension-kit-gen-3-EXT3/) and [Touch expansion board (EXT3-Touch)](https://www.pervasivedisplays.com/product/touch-expansion-board-ext3-touch/) -* Pervasive Displays iTC [monochrome screens with touch](https://www.pervasivedisplays.com/products/?_sft_etc_itc=tp) +* Pervasive Displays EPD Extension Kit Gen 3 (EXT3 or EXT3-1) +* Pervasive Displays E-paper touch display development kit (EXT3-Touch) +* Pervasive Displays iTC monochrome screens with touch ## Licence