small doc update

[spray] / Readme.org

diff --git a/Readme.org b/Readme.org
index 9f30145d41f260de0c51714ee1efca373e2432df..887294e21d36b99352719bc17f6f34da8275412c 100644 (file)
--- a/Readme.org
+++ b/Readme.org
@@ -2,9 +2,48 @@
 
 A speed reading mode for Emacs.
 
-The algorithm is taken from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]] (with a few modifications).
+The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]].
+
+** Deficiencies in similar projects which spray.el solves:
+
+Mostly as of June 28, 2014.
+
+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.
 
-NOTE: This is a WIP project and thus APIs may change.
 
 ** Screencast
 
@@ -12,7 +51,7 @@ NOTE: This is a WIP project and thus APIs may change.
 
 ** Installation
 
-Put cedit.el into a "load-path"ed directory, and load it in your init
+Put spray.el into a "load-path"ed directory, and load it in your init
 file.
 
 : (require 'spray)
@@ -41,7 +80,9 @@ In spray-mode buffers, following commands are available.
 - =spray-slower= (s) ::
      decreases speed
 
-Press any key else to quit =spray-mode=.
+- =spray-quit= (q, <return>) ::
+     quit =spray-mode=
+
 
 ** Customization
 
@@ -49,6 +90,13 @@ 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-orp-face
+- [Face] spray-accent-face
+
+
+** Contributions are welcome!
+
+There's lots of features and enhancements to do. The algorithm has lots of room for improvement. Also, other projects may have algorithm improvements we can port over to this one.