X-Git-Url: https://iankelling.org/git/?p=spray;a=blobdiff_plain;f=Readme.org;h=9485f1b8a0fc0b75528176e12f0b3652a8e17f58;hp=09b323a8d5ce0c9b826478212543ba269db9c5b3;hb=091c1d22fdca14e2cb7e3170c5f8ec191d996280;hpb=02d31260eed4067fbbff2d5a194171a0228bc791 diff --git a/Readme.org b/Readme.org index 09b323a..9485f1b 100644 --- a/Readme.org +++ b/Readme.org @@ -4,6 +4,14 @@ A speed reading mode for Emacs. The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]]. + +** Screencast + +[[screencast.gif]] + +The story continues at [[https://www.gnu.org/philosophy/right-to-read.html][gnu.org]] + + ** Deficiencies in similar projects which spray.el solves: Mostly as of June 28, 2014. @@ -44,11 +52,6 @@ Downsides compared to similar projects: - The emacs learning curve. - Would be hard to get running on a phone. - -** Screencast - -[[screencast.gif]] - ** Installation Put spray.el into a "load-path"ed directory, and load it in your init @@ -92,6 +95,7 @@ You may customize spray by modifying following items: - [Variable] spray-height - [Variable] spray-margin-top - [Variable] spray-margin-left +- [Variable] spray-ramp - [Keymap] spray-mode-map - [Face] spray-base-face - [Face] spray-accent-face @@ -107,6 +111,8 @@ Words are split at space, tab, newline, and emdash characters. If any of the cha Each word is displayed for (60 / the choosen wpm) seconds, except if the word ends with ,:— or is greater than 9 characters long, in which case it is displayed for twice as long. +When started, an added delay is optionally added, based on the spray-ramp variable. See it's documentation for details. + The accent location is chosen as the nth character in a word, depending on its length, based on the following table | length | accent position | | 1 | 1 |