iankelling.org Git - spray/blob - Readme.org

   1 * spray.el
   2
   3 A speed reading mode for Emacs.
   4
   5 The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]].
   6
   7 ** Deficiencies in similar projects which spray.el solves:
   8
   9 For all other projects, it is very difficult to save your place and come back later. Emacs has lots of built in features
  10 like bookmarks which make this easy.
  11
  12 - https://github.com/jbmartinez/speed-readerff firefox extension.
  13 - https://github.com/cameron/squirt javascript bookmarklet.
  14 - https://github.com/Miserlou/OpenSpritz javascript bookmarklet.
  15   - Very difficult selecting where to start / what exactly to read.
  16   - Very difficult to figure out where you are within a document.
  17
  18
  19 - https://github.com/chaimpeck/spray website you paste text into.
  20   - Very difficult to figure out where you are within a document.
  21
  22 - https://github.com/xypiie/spread0r Perl program.
  23   - No apparent way to resize text.
  24   - Very difficult to figure out where you are within a document.
  25
  26
  27 - https://github.com/the-happy-hippo/sprits-it website or bookmarklet. Looks most promising of the web based projects.
  28   - Very difficult selecting where to start / what exactly to read.
  29   - Somewhat difficult to figure out where you are in a document.
  30
  31
  32 Programs that I, Ian Kelling, didn't try, and why. They also probably have a lot of the problems listed above.
  33 - https://github.com/pasky/speedread No simple way to resize text from default of too small.
  34 - 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.
  35 - 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.
  36 - 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.
  37
  38
  39 Downsides compared to similar projects:
  40 - The emacs learning curve.
  41 - Would be hard to get running on a phone.
  42
  43
  44 ** Screencast
  45
  46 [[screencast.gif]]
  47
  48 ** Installation
  49
  50 Put spray.el into a "load-path"ed directory, and load it in your init
  51 file.
  52
  53 : (require 'spray)
  54
  55 Then you can start spraying from the cursor position with =M-x
  56 spray-mode=. Binding some keys may also be useful.
  57
  58 : (global-set-key (kbd "<f6>") 'spray-mode)
  59
  60 ** Commands
  61
  62 In spray-mode buffers, following commands are available.
  63
  64 - =spray-start/stop= (SPC) ::
  65      pause or resume spraying
  66
  67 - =spray-backward-word= (h, <left>) ::
  68      pause and back to the last word
  69
  70 - =spray-forward-word= (l, <right>) ::
  71      inverse of =spray-backward-word=
  72
  73 - =spray-faster= (f) ::
  74      increases speed
  75
  76 - =spray-slower= (s) ::
  77      decreases speed
  78
  79 - =spray-quit= (q, <return>) ::
  80      quit =spray-mode=
  81
  82
  83 ** Customization
  84
  85 You may customize spray by modifying following items:
  86
  87 - [Variable] spray-wpm
  88 - [Variable] spray-height
  89 - [Variable] spray-margin-top
  90 - [Variable] spray-margin-left
  91 - [Keymap] spray-mode-map
  92 - [Face] spray-base-face
  93 - [Face] spray-accent-face
  94
  95