small doc update
[spray] / README.org
index 7bea711369f31e91433ba403b499ec04bff84260..cabb3d708f52caff1cb23fea2c51d065934bf5be 100644 (file)
@@ -2,8 +2,6 @@
 
 A speed reading mode for Emacs.
 
-The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]].
-
 
 ** Screencast
 
@@ -59,6 +57,28 @@ You may customize spray by modifying following items:
 - [Face] spray-base-face
 - [Face] spray-accent-face
 
+** 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, etc.
 
 Bug tracking is on github.
@@ -73,6 +93,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:
@@ -140,4 +162,4 @@ on its length, based on the following table
 
 ** Contributions are welcome!
 
-There's lots of features and enhancements to do. The algorithm and interface could certainly be improved in various ways.
+There's lots of features and enhancements to do. The algorithm and interface could certainly be improved in various ways. Contribute at https://gitlab.com/iankelling/spray.