X-Git-Url: https://iankelling.org/git/?p=spray;a=blobdiff_plain;f=README.org;h=1b9fcb4f182ece2ab955ac8cc5402eb2382247e0;hp=7bea711369f31e91433ba403b499ec04bff84260;hb=HEAD;hpb=ecb0425a3c49b4bcb1ac1d3ccbeec2061ff43978 diff --git a/README.org b/README.org index 7bea711..1b9fcb4 100644 --- a/README.org +++ b/README.org @@ -1,8 +1,6 @@ * spray.el -A speed reading mode for Emacs. - -The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]]. +A speed reading mode for Emacs ** Screencast @@ -59,10 +57,33 @@ You may customize spray by modifying following items: - [Face] spray-base-face - [Face] spray-accent-face -** Feedback, bugs, etc. +** If your emacs color theme does not work well with spray + +You could create a function to toggle the emacs theme to one that +works with spray, and then put that in the spray mode hook. For example: + +#+begin_src emacs-lisp +(defun toggle-night () + (interactive) + (if (equal (car custom-enabled-themes) 'naquadah) + (override-theme 'leuven) + (override-theme 'naquadah))) +(add-hook 'spray-mode-hook 'toggle-night) +#+end_src + +Alternatively, one user found ways to setup a single buffer with better colors, using +- http://www.emacswiki.org/emacs/BufferBackgroundColor +- https://github.com/vic/color-theme-buffer-local + +He also found this library useful: +https://github.com/ShingoFukuyama/ov.el + + +** Feedback, bugs, contributions, all welcome -Bug tracking is on github. -Mailing list for any feedback, questions, etc: https://lists.iankelling.org/listinfo/spray +All on: https://gitlab.com/iankelling/spray + +There's lots of features and enhancements to do. The algorithm and interface could certainly be improved in various ways. ** Similar emacs package: speedread @@ -73,6 +94,8 @@ packages. ** Deficiencies in similar projects which spray.el solves: +The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]]. + Mostly as of June 28, 2014. For all other projects: @@ -136,8 +159,3 @@ on its length, based on the following table | 6-9 | 3 | | 10-13 | 4 | | 14+ | 5 | - - -** Contributions are welcome! - -There's lots of features and enhancements to do. The algorithm and interface could certainly be improved in various ways.