From 02bbc35b7021b5605134094dc43da38f5166d626 Mon Sep 17 00:00:00 2001 From: Rei Vilo Date: Thu, 12 Sep 2024 14:34:11 +0200 Subject: [PATCH] Updated README --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b94f9e5..cb1dd65 100755 --- a/README.md +++ b/README.md @@ -1,36 +1,46 @@ # Pervasive Displays Library Suite - Basic Edition - Fast Update -[![Release](https://img.shields.io/github/v/release/rei-vilo/PDLS_EXT3_Basic_Fast)](https://github.com/rei-vilo/PDLS_EXT3_Basic_Global/releases) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/77ecc9fa99834e299505f5f2a7c83e53)](https://app.codacy.com/gh/rei-vilo/PDLS_EXT3_Basic_Fast/dashboard?utm_source=github.com&utm_medium=referral&utm_content=rei-vilo/PDLS_EXT3_Basic_Global&utm_campaign=Badge_Grade) ![Arduino lint](https://github.com/rei-vilo/PDLS_EXT3_Basic_Fast/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_Fast)](https://github.com/rei-vilo/PDLS_EXT3_Basic_Global/releases) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/77ecc9fa99834e299505f5f2a7c83e53)](https://app.codacy.com/gh/rei-vilo/PDLS_EXT3_Basic_Fast/dashboard?utm_source=github.com&utm_medium=referral&utm_content=rei-vilo/PDLS_EXT3_Basic_Global&utm_campaign=Badge_Grade) ![Arduino lint](https://github.com/rei-vilo/PDLS_EXT3_Basic_Fast/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_Fast** provides a high-level interface to drive the e-paper screens with embedded fast update: +The **PDLS_EXT3_Basic_Fast** supports the screens -+ [EPD Extension Kit Gen 3 (EXT3 or EXT3-1)](https://www.pervasivedisplays.com/product/epd-extension-kit-gen-3-EXT3/); and + iTC [monochrome screens with embedded fast update](https://www.pervasivedisplays.com/products/?_sft_etc_itc=pu) (film `PS`); * iTC [monochrome screens with embedded fast update and wide temperature](https://www.pervasivedisplays.com/products/?_sft_etc_itc=pu&_sft_temperature_range=m15c-to-p60c) (film `KS`). -Please refer to [PDLS_EXT3_Basic_Global](https://github.com/rei-vilo/PDLS_EXT3_Basic_Global/issues) for reporting issues and contributing pull requests. +the boards + ++ [EPD Extension Kit Gen 3 (EXT3 or EXT3-1)](https://www.pervasivedisplays.com/product/epd-extension-kit-gen-3-EXT3/); + +the kits + ++ the [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. https://user-images.githubusercontent.com/951776/132012290-8680632a-b45c-417e-a7fe-d625f7e8af26.mp4 ## Features +The Pervasive Displays Library Suite provides a high-level interface to drive the e-paper screens. + + Fast update + Graphics routines + Text routines + Four extended fonts with double-sized variants -## 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 +64,9 @@ Software Hardware -* Pervasive Displays [EPD Extension Kit Gen 3 (EXT3 or EXT3-1)](https://www.pervasivedisplays.com/product/epd-extension-kit-gen-3-EXT3/) -* Pervasive Displays iTC [monochrome screens with embedded fast update](https://www.pervasivedisplays.com/products/?_sft_etc_itc=pu) +* Pervasive Displays EPD Extension Kit Gen 3 (EXT3 or EXT3-1) +* Pervasive Displays iTC monochrome screens with embedded fast update (film `PS`) +* Pervasive Displays iTC monochrome screens with embedded fast update and wide temperature (film `KS`) ## Licence