diff --git a/README.md b/README.md index 91677e4..00f3164 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,20 @@ -# braille_display -[![GitHub Actions Workflow Status - build.yaml](https://img.shields.io/github/actions/workflow/status/dakalamin/braille_display/build.yaml?style=flat-square&label=PlatformIO%20build)](https://github.com/dakalamin/braille_display/actions/workflows/build.yaml) -[![GitHub Actions Workflow Status - check_readme.yaml](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/dakalamin/a03fafd87cde1d5878f7955cac843017/raw/braille_display_readme_badge.json)](https://github.com/dakalamin/braille_display/actions/workflows/check_readme.yaml) +# braille_display -[![GitHub Release](https://img.shields.io/github/v/release/dakalamin/braille_display?sort=semver&display_name=tag&style=flat-square&label=Latest%20release)](https://github.com/dakalamin/braille_display/releases) -[![GitHub License](https://img.shields.io/github/license/dakalamin/braille_display?style=flat-square&label=License)](#license) +[![Arduino](https://img.shields.io/badge/Arduino-00878F?style=for-the-badge&logo=arduino)](https://www.arduino.cc/) +[![PlaformIO](https://img.shields.io/badge/PlatformIO-F5822A?style=for-the-badge&logo=platformio&logoColor=white)](https://platformio.org) +[![Wokwi][wokwi-badge-link]][wokwi-project-link] This project implements a scalable multi-cell Braille display system using an Arduino - it converts input characters into their corresponding Braille patterns, providing accessibility for visually impaired users ![project breadboard scheme](assets/diagram.png) +[![GitHub Actions Workflow Status - build.yaml](https://img.shields.io/github/actions/workflow/status/dakalamin/braille_display/build.yaml?style=flat-square&label=PlatformIO%20build)](https://github.com/dakalamin/braille_display/actions/workflows/build.yaml) +[![GitHub Actions Workflow Status - check_readme.yaml](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/dakalamin/a03fafd87cde1d5878f7955cac843017/raw/braille_display_readme_badge.json)](https://github.com/dakalamin/braille_display/actions/workflows/check_readme.yaml) + +[![GitHub Latest Release](https://img.shields.io/github/v/release/dakalamin/braille_display?sort=semver&display_name=tag&style=flat-square&label=Latest%20release)][latest-release-link] +[![GitHub License](https://img.shields.io/github/license/dakalamin/braille_display?style=flat-square&label=License)](#license) + ## Table of Contents @@ -29,10 +34,10 @@ This project implements a scalable multi-cell Braille display system using an Ar ### **1. In simulation via [Wokwi](https://wokwi.com)** -- Follow the [Wokwi-project link](https://wokwi.com/projects/410634164212519937) +- Follow the [Wokwi-project link][wokwi-project-link] > [!NOTE] > If Wokwi-project link is broken or project there is corrupted, please report it to [GitHub Issues](https://github.com/dakalamin/braille_display/issues), meanwhile: -> - Clone or [download](https://github.com/dakalamin/braille_display/releases/latest) and unpack the repository +> - Clone or [download][latest-release-link] and unpack the repository > - Start a [blank Wokwi-project](https://wokwi.com/projects/new/blank) > - Select **`diagram.json`** tab > - Press ⏷ button to the right of **'Library Manager'** tab, then - **'Delete'** and confirm @@ -44,7 +49,7 @@ This project implements a scalable multi-cell Braille display system using an Ar - Install [Visual Studio Code](https://code.visualstudio.com) and launch it - Install [PlatformIO IDE](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide) extension for VSCode -- Clone or [download](https://github.com/dakalamin/braille_display/releases/latest) and unpack the repository +- Clone or [download][latest-release-link] and unpack the repository - Open **`braille_display/`** project's folder with VSCode - Connect your Arduino via USB to your computer > [!NOTE] @@ -59,7 +64,7 @@ This project implements a scalable multi-cell Braille display system using an Ar ### **3. On real Arduino via ArduinoIDE** -- Clone or [download](https://github.com/dakalamin/braille_display/releases/latest) and unpack the repository +- Clone or [download][latest-release-link] and unpack the repository - Use an appropriate script from the project's **`scripts/`** folder to change project structure _(double click it or call it from console)_: - **`toggle.batch`** for Windows - **`toggle.bash`** for Linux @@ -92,7 +97,7 @@ Press the button to display the next set of Braille patterns - Program can translate following symbols into Braille: - **Latin** alphabet - **Cyrillic** alphabet - - **Numbers** + - **Digits** - frequently used **Punctuation** - You can send messages one after another not waiting for the previous ones to be shown - program will try to concatenate them until the `rx_buffer` _(receiving buffer)_ is full @@ -185,3 +190,8 @@ Feel free to contribute to this project by submitting issues or pull requests! ## License This project is open-source and available under the [MIT License](LICENSE) + + +[wokwi-badge-link]: https://img.shields.io/badge/Wokwi-4A96E2?style=for-the-badge&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxOS44MTYgMTYuNDA2Ij48ZyBmaWxsPSIjZmZmIj48cGF0aCBkPSJNNC4xOTIgMTUuNTI0Yy0uNjMtLjczOC0uNzY1LTEuODYzLS4zMi0yLjY4NC40MDUtLjc0OC4zNDYtMS4xMzYtLjU4My0zLjg0LS45MzctMi43My0xLjExNi0zLjA1LTEuOTM1LTMuNDU1LTEuOTE2LS45NS0xLjc2NS0zLjQ1My4yNDItNC4wMDFDMy40ODggMS4wMjcgNC45NyAyLjkzIDQuMDE0IDQuNjQ5Yy0uNDE2Ljc1LS4zNiAxLjExMy41OTMgMy44NjYuOTcgMi43OTYgMS4xMjYgMy4wNzEgMS45NjQgMy40NTYgMS4xOTIuNTQ5IDEuNjIgMS44ODQuOTY5IDMuMDI1LS42NSAxLjE0LTIuNTY2IDEuNDQxLTMuMzQ4LjUyOG0xLjkxMi0xLjAwM2MuNDY1LS4zOC40MjYtLjc5Ni0uMTAzLTEuMDk4LS4yMzgtLjEzNi0uNTQ0LS4xODYtLjY4MS0uMTEyLS40MjMuMjMtLjQwNyAxLjAxNC4wMjUgMS4yNi4yMjYuMTMuNTY3LjEwNy43Ni0uMDV6TTIuNjEyIDQuMTY0Yy4zNDYtLjE4OS4yMjQtMS4wNzgtLjE4LTEuMzA4LS4zMzctLjE5My0uOTk1LjI2OC0uOTguNjg2LjAxMy4zODcuODA5LjgxMyAxLjE2LjYyMm05LjMzMyAxMC44M2MtLjYzLS43MzgtLjc2NS0xLjg2My0uMzItMi42ODQuNDA1LS43NDguMzQ2LTEuMTM2LS41ODMtMy44NC0uOTM3LTIuNzMtMS4xMTYtMy4wNS0xLjkzNS0zLjQ1NS0xLjkxNi0uOTUtMS43NjUtMy40NTMuMjQyLTQuMDAxQzExLjI0LjQ5NyAxMi43MjMgMi40IDExLjc2NyA0LjExOWMtLjQxNi43NS0uMzYgMS4xMTMuNTkzIDMuODY2Ljk3IDIuNzk2IDEuMTI2IDMuMDcxIDEuOTY0IDMuNDU2IDEuMTkyLjU0OSAxLjYyIDEuODg0Ljk2OSAzLjAyNS0uNjUgMS4xNC0yLjU2NiAxLjQ0MS0zLjM0OC41MjhtMS45MTItMS4wMDNjLjQ2NS0uMzguNDI2LS43OTYtLjEwMy0xLjA5OC0uMjM4LS4xMzYtLjU0NC0uMTg2LS42ODEtLjExMi0uNDIzLjIzLS40MDcgMS4wMTQuMDI1IDEuMjYuMjI2LjEzLjU2Ny4xMDcuNzYtLjA1ek0xMC4zNjUgMy42MzRjLjM0Ni0uMTg5LjIyNC0xLjA3OC0uMTgtMS4zMDgtLjMzNy0uMTkzLS45OTUuMjY4LS45OC42ODcuMDEzLjM4Ni44MDkuODEyIDEuMTYuNjJ6Ii8%2BPHBhdGggZD0iTTQuNTQzIDE2LjIxNGMtMi4wMjctMS4xODctMS4zLTQuMTg1IDEuMDE1LTQuMTg1Ljc1IDAgLjgxNi0uMTc3IDEuODY0LTEuMTY5IDEuMDQ3LS45OTIgMi44MzMtMi42MjcgNC4wMzUtMy4yMjIuMzI0LjQ2LjU3MSAxLjYxNS42MDcgMS43NDgtLjc3MiAwLTIuNzUgMS41MTUtMy41ODggMi41MzgtLjgxLjk4OC0uOTg1IDEuNC0uOTI4IDIuMTg4LjA1Mi43My0uMDgxIDEuMTEtLjU0MSAxLjU0LS43OC43MjgtMS43ODcuOTU4LTIuNDY0LjU2Mm0xLjU2LTEuNjk1Yy4yMTUtLjU2LS4wMjUtLjkwMy0uNjM0LS45MDMtLjU5NCAwLS44OTYuNDEtLjY5My45NC4xOTguNTE1IDEuMTI1LjQ5IDEuMzI3LS4wMzdtNy4wODItMi40NjVzLjI4NC0uNTY1IDEuMzkyLTMuNzE3YzEuNDQtNC4wNzggMS41MDktNC40MDcgMS4wOTYtNS4yNjMtLjg4Ny0xLjg0LjgzNS0zLjY4NCAyLjY5MS0yLjg4LjY5NC4zLjkzMS41ODUgMS4yMzYgMS40OS4zMzIuOTgzLjMwMyAxLjE5LS4yNDQgMS43Mi0uMzQxLjMzLS44OTYuNzE2LTEuMjMxLjg1Ni0uNDcuMTk2LS45NzIgMS4yNTUtMi4xODYgNC42MTgtMS40NDMgMy45OTYtMS4wNiAyLjgxNy0uNjcgMy41NDEuOTYxIDEuNzktLjI2LjQ5Mi0yLjA4My0uMzY1em01LjA2Ni05Ljg1Yy0uMDA2LS42LS4zNTUtLjgzLS45MjEtLjYwNS0uMjU1LjEtLjQ4Ni4zMDktLjUxMy40NjItLjA4NS40NzMuNTM3Ljk1MSAxIC43NjguMjQxLS4wOTYuNDM3LS4zNzcuNDM0LS42MjUiLz48L2c%2BPC9zdmc%2B +[wokwi-project-link]: https://wokwi.com/projects/410634164212519937 +[latest-release-link]: https://github.com/dakalamin/braille_display/releases/latest