Skip to content

Latest commit

 

History

History
131 lines (79 loc) · 6 KB

README.md

File metadata and controls

131 lines (79 loc) · 6 KB
Raw

Read Easy: Dyslexia-Friendly Browser Extension

Description

Read Easy is a browser extension designed to make literature more accessible and enjoyable for everyone, especially for individuals with dyslexia. By leveraging dyslexia-friendly tools, such as the OpenDyslexic font and text-to-speech features, Read Easy aims to enhance the reading experience for users with dyslexia.

Features

  • Dyslexia-Friendly Fonts: Utilize over 200+ fonts, including 6 OpenDyslexic fonts, specifically designed to increase readability for users with dyslexia.
  • Text-to-Speech: Convert text into speech to assist users with dyslexia in reading and comprehending text more easily.
  • Customizable Reading Experience: Customize font size, color schemes, and layouts to suit individual preferences and needs.
  • Color and Contrast Adjustment: Options to modify background and text colors to reduce strain.
  • Layout Optimization: Simplifies page layouts to enhance focus and understanding.

Built With

  • HTML
  • CSS
  • JavaScript

User Interface

Read.Easy.mov

Installation

Manual Instalation

To get started with Read Easy, follow these steps:

  1. Clone the repository to your local machine.

    git clone https://github.com/sherwinvishesh/Read-Easy.git

  2. Navigate to the Browser-Extension directory where the source code is located.

    cd Read-Easy
cd Browser-Extension
open .

  3. Load the extension into your browser:

    • For Chrome:
      1. Go to chrome://extensions/
      2. Enable Developer Mode.
      3. Click "Load unpacked" and select the Browser-Extension folder.
    • For Firefox:
      1. Go to about:debugging
      2. Click "This Firefox."
      3. Click "Load Temporary Add-on" and select any file within the Browser-Extension folder.

Direct Installation

Read Easy will soon be available on Google Chrome Web Store

ASU-FURI Research

The ASU-FURI folder is dedicated to the research paper developed during the ASU-FURI (Arizona State University Fulton Undergraduate Research Initiative) project. This section will host the research paper and related materials upon completion.

Usage

After installing Read Easy, you will find a simple and intuitive interface to tailor your reading experience on the web. Here's how you can use the various features:

  1. Accessing the Extension: Click on the Read Easy icon in your browser's toolbar to open the control panel.

  2. Font Manipulation:

    • Toggle Default: Switch between the default browser font and your chosen settings with the 'Toggle Default' switch.
    • Font Type: Select from the OpenDyslexic font options, including styles like OpenDyslexic-Bold, to improve readability.
    • or Use Google Font: For additional font options, you can opt to use fonts from Google Fonts.

  3. Customization:

    • Scale: Adjust the font size by changing the scale to make the text larger or smaller according to your needs.
    • Color: Change the font color to increase contrast and reduce eye strain.

  4. Spacing Controls:

    • Word Spacing: Increase or decrease the space between words.
    • Line Spacing: Adjust the space between lines of text to prevent crowding.
    • Letter Spacing: Modify the space between letters to help in distinguishing individual characters.

  5. Overlays: Enhance focus and tracking by enabling overlays that guide your reading.

  6. Reading Controls: Optimize the page layout to minimize distractions and focus on the text.

  7. Ruler: Use the on-screen ruler to follow lines of text and maintain your place.

Remember, Read Easy is designed to be flexible and can be turned on or off as needed. Feel free to experiment with different settings to find what works best for you. If you find something particularly helpful or have suggestions, please provide us with feedback!

About Open Dyslexia

OpenDyslexic is a new open sourced font created to increase readability for readers with dyslexia. The typeface includes regular, bold, italic, and bold-italic styles, and 2 typefaces: OpenDyslexic, and OpenDyslexic-Alta. It was created to help with my reading, and is being updated continually and improved based on input from other dyslexic users. There are no restrictions on using OpenDyslexic. OpenDyslexic is created to help with some of the symptoms of dyslexia. Letters have heavy weighted bottoms to indicate direction. You are able to quickly figure out which part of the letter is down which aids in recognizing the correct letter, and sometimes helps to keep your brain from rotating them around. Consistently weighted bottoms can also help reinforce the line of text. The unique shapes of each letter can help prevent confusion through flipping and swapping.

FC1 OpenDyslexic uses unique letter shapes, to help prevent confusion.

FC2

A heavier bottom is used to show which way is supposed to be down. OpenDyslexic also has other features, like wider letter spacing and a unique italic style.

Contributing

Contributions to enhance this project are welcomed. Please feel free to fork the repository, make changes, and submit pull requests.

Support

If you encounter any issues or have any questions, please submit an issue on the GitHub issue tracker or feel free to contact me.

License

Read Easy is open source and available under the Apache-2.0 License.

Acknowledgments

  • Special thanks to the OpenDyslexic project for providing the fonts used in this extension.
  • Thanks to everyone who visits and uses this page. Your interest and feedback are what keep us motivated.
  • Special thanks to all the contributors who help maintain and improve this project. Your dedication and hard work are greatly appreciated.

Connect with Me

Feel free to reach out and connect with me on LinkedIn or Instagram.

Made with ❤️ by Sherwin