search

SamClercky / Dyxitool

A Firefox and Chrome extension that makes it easier for people with dyslexia
https://samclercky.github.io/Dyxitool/
GNU General Public License v2.0
9 stars 0 forks source link
chrome-extension dyslexic firefox-extension mobile

readme

Dyxitool

Current status of the project

The extension has been submitted to the Firefox webstore and for the first time to the Chrome webstore. The extension will be listed soon on both stores.

This is a firefox and chrome extension that will help people with dyslexia.

1. Installing the plugin

Prebuild files can be found in ./build/ folder or the releases part of the Github page altough this is not the recommended way, since they are also hosted in the official marketplace of your browser's extension shop.

2. Building the project

WARNING: These instructions are ment for a UNIX-compatible terminal. If you are using Windows, you can use docker or WSL (Windows Subsystem Linux)

Step 1: Downloading

Depending on your system you can download this repo through git or by clicking the download link on Github.

$ git clone https://github.com/SamClercky/Dyxitool.git

Step 2: Download dependencies

This project is build with gulp. I use node v10.15.2 and npm v6.10.3. Normaly the version numbers should not matter a lot, but if it doesn't work, these were my configurations.

$ npm install

Step 3: build typescript

$ npx tsc

Step 3: build the Firefox- or Chrome part

Now choose which part you want to build because each build command will firstly clean the ./dist/ folder.

Build for Firefox

$ npx gulp firefox
$ cd dist
$ npx web-ext build
$ mv web-ext-artifacts/dyxitool-1.1.zip web-ext-artifacts/dyxitool-1.1.xpi

After this you will find a ready to use (unsigned) build in ./dist/web-ext-artifacts/

Build for Chrome

$ npx gulp chrome

Now go to your chrome browser and go to chrome://extensions/. Make sure you enable Dev-mode before you can Package extension. Fill in the path to the ./dist/ folder. (you can leave the private-key part open). The final buildfile will be found in the root directory of this project.

3. License

This code is licensed under GPLv2. Everything except the ./fonts/ folder and the ./lib/ folder. These contain code from other libraries or projects and have their own license.

Links to corresponding website

4. Dependencies

To make it easier to bulid the project exact as I did, the used libraries are wget'ed into a local ./lib/ folder. Since some webbrowser markets still want a link to the original files, here is a list.

The files in the ./lib/ folder are wget'ed from following url's