small doc update

[spray] / Readme.org

diff --git a/Readme.org b/Readme.org
index abdeff15b070ff352e440078bb3a442aaff77ae2..b4b78db26cabedda8b104327bd223f0c812c961e 100644 (file)
--- a/Readme.org
+++ b/Readme.org
@@ -1,16 +1,97 @@
 * spray.el
 
-A speed reading mode for Emacs (an elisp implementation of
-[[https://github.com/Miserlou/OpenSpritz][OpenSpritz]]).
+A speed reading mode for Emacs.
+
+The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]].
+
+** Deficiencies in similar projects which spray.el solves:
+
+For all other projects:
+- It is very difficult to save your place and come back later. Emacs has lots of built in features like bookmarks or just making a note which make this easy.
+- No keybinds. This is especially useful for common, quickly used functionality like pause and back up.
+
+Specific projects:
+- https://github.com/jbmartinez/speed-readerff firefox extension.
+- https://github.com/cameron/squirt javascript bookmarklet.
+- https://github.com/Miserlou/OpenSpritz javascript bookmarklet.
+  - Very difficult selecting where to start / what exactly to read. 
+  - Very difficult to figure out where you are within a document. 
+
+
+- https://github.com/chaimpeck/spray website you paste text into. 
+  - Very difficult to figure out where you are within a document. 
+
+- https://github.com/xypiie/spread0r Perl program.  
+  - No apparent way to resize text.
+  - Very difficult to figure out where you are within a document. 
+
+
+- https://github.com/the-happy-hippo/sprits-it website or bookmarklet. Looks most promising of the web based projects.
+  - Very difficult selecting where to start / what exactly to read. 
+  - Somewhat difficult to figure out where you are in a document.
+
+
+Programs that I, Ian Kelling, didn't try, and why. They also probably have a lot of the problems listed above.
+- https://github.com/pasky/speedread No simple way to resize text from default of too small.
+- https://github.com/ds300/jetzt Chrome plugin: Chrome is proprietary, and its open source version is unfriendly to linux distros so they don't package it, and it's readme does not list any benefit to this program over others.
+- https://github.com/Fr4ncis/openspritz-ios ios program. I don't have an ios device, and this does not appear to have any compelling features.
+- https://github.com/OnlyInAmerica/OpenSpritz-Android android program. If I knew how to quickly move reading material to my phone, I would try this out. But, it's readme shows that the program is pretty sparse and would have some of the same problems as listed above, so not worth it.
+
+
+Downsides compared to similar projects:
+- The emacs learning curve.
+- Would be hard to get running on a phone.
+
+
+** Screencast
+
+[[screencast.gif]]
 
 ** Installation
 
-Put this script into a "load-path"ed directory, and load it in your
-init file.
+Put spray.el into a "load-path"ed directory, and load it in your init
+file.
 
 : (require 'spray)
 
-Then you may run spray with "M-x spray-mode". Binding some keys may
-also be useful.
+Then you can start spraying from the cursor position with =M-x
+spray-mode=. Binding some keys may also be useful.
 
 : (global-set-key (kbd "<f6>") 'spray-mode)
+
+** Commands
+
+In spray-mode buffers, following commands are available.
+
+- =spray-start/stop= (SPC) ::
+     pause or resume spraying
+
+- =spray-backward-word= (h, <left>) ::
+     pause and back to the last word
+
+- =spray-forward-word= (l, <right>) ::
+     inverse of =spray-backward-word=
+
+- =spray-faster= (f) ::
+     increases speed
+
+- =spray-slower= (s) ::
+     decreases speed
+
+- =spray-quit= (q, <return>) ::
+     quit =spray-mode=
+
+
+** Customization
+
+You may customize spray by modifying following items:
+
+- [Variable] spray-wpm
+- [Variable] spray-height
+- [Variable] spray-margin-top
+- [Variable] spray-margin-left
+- [Keymap] spray-mode-map
+- [Face] spray-base-face
+- [Face] spray-accent-face
+
+