From be097473fb2c8b9f88fe2a987c4fd6e9a7991cd2 Mon Sep 17 00:00:00 2001 From: John Peter Sa <156824256+johnpetersa19@users.noreply.github.com> Date: Sat, 17 Jan 2026 14:32:48 -0300 Subject: [PATCH 1/2] Refactor README for better readability and structure Updated README.md to improve formatting and clarity. --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index dea447c..12ab248 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,51 @@ -# Spedread +# Spedread -GTK speed reading software: Read like a speedrunner! +**GTK speed reading software: Read like a speedrunner!** -This program will show one word at a time rapidly to allow focusing on the general idea rather than single words -along with less eye movements +This program will show one word at a time rapidly to allow focusing on the general idea rather than single words along with less eye movements. -## Features +--- -![screenshot](./demo.gif) +## ✨ Features -- International -- Play, pause, next word & previous word -- Control the speed at which words are shown +- **International** — Multi-language support +- **Intuitive controls** — Play, pause, next word & previous word +- **Adjustable speed** — Control the speed at which words are shown -## Install +--- + +## 📦 Install ### Flatpak This application is available as a Flatpak on Flathub: - - Download on Flathub - +**[Download on Flathub](https://flathub.org/apps/details/com.github.Darazaki.Spedread)** ### Snap A snap version is available on Canonical's Snap Store: - - Get it from the Snap Store - +**[Get it from the Snap Store](https://snapcraft.io/spedread)** -This snap was originally created and maintained by @sameersharma2006 +*This snap was originally created and maintained by @sameersharma2006* ### AUR Two packages are available on the AUR: -[spedread](https://aur.archlinux.org/packages/spedread) -and [spedread-git](https://aur.archlinux.org/packages/spedread-git) -These packages are maintained by both Igor Dyatlov and me so if you have any -issues with the packaging please report them directly onto the AUR +- [spedread](https://aur.archlinux.org/packages/spedread) +- [spedread-git](https://aur.archlinux.org/packages/spedread-git) + +*These packages are maintained by both Igor Dyatlov and me so if you have any issues with the packaging please report them directly onto the AUR.* + +--- -### Build from source (native install) +## 🔧 Build from Source -This will require a valid Vala compiler and the GTK4 and libadwaita development files: +### Native Install + +**Requirements:** Valid Vala compiler and the GTK4 and libadwaita development files ```sh git clone https://github.com/Darazaki/Spedread spedread @@ -57,13 +56,11 @@ ninja sudo ninja install ``` -You can also run `sudo ninja uninstall` from the `build/` directory to -uninstall Spedread after having installed it +**To uninstall:** Run `sudo ninja uninstall` from the `build/` directory -### Build from source (Flatpak install) +### Flatpak Install -This will require having the `flatpak-builder` & `appstream-compose` commands -installed along with version 49 of the `org.gnome.Sdk` Flatpak package: +**Requirements:** `flatpak-builder` & `appstream-compose` commands installed along with version 49 of the `org.gnome.Sdk` Flatpak package ```sh git clone https://github.com/Darazaki/Spedread spedread @@ -71,5 +68,8 @@ cd spedread dev-scripts/build.sh --install ``` -Spedread will then be installed as a Flatpak application and can be managed as -such +Spedread will then be installed as a Flatpak application and can be managed as such. + +--- + +**Repository:** [github.com/Darazaki/Spedread](https://github.com/Darazaki/Spedread) From fde053c9b21fef23c7425057a7d6b7601e4a134e Mon Sep 17 00:00:00 2001 From: John Peter Sa <156824256+johnpetersa19@users.noreply.github.com> Date: Sat, 17 Jan 2026 14:34:06 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 12ab248..ed99672 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,19 @@ This program will show one word at a time rapidly to allow focusing on the gener This application is available as a Flatpak on Flathub: -**[Download on Flathub](https://flathub.org/apps/details/com.github.Darazaki.Spedread)** + + Download on Flathub + ### Snap A snap version is available on Canonical's Snap Store: -**[Get it from the Snap Store](https://snapcraft.io/spedread)** + + Get it from the Snap Store + *This snap was originally created and maintained by @sameersharma2006*