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

   1 * spray.el
   2
   3 A speed reading mode for Emacs.
   4
   5 The algorithm is taken from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]] (with a few modifications).
   6
   7 NOTE: This is a WIP project and thus APIs may change.
   8
   9 ** Screencast
  10
  11 [[screencast.gif]]
  12
  13 ** Installation
  14
  15 Put cedit.el into a "load-path"ed directory, and load it in your init
  16 file.
  17
  18 : (require 'spray)
  19
  20 Then you can start spraying from the cursor position with =M-x
  21 spray-mode=. Binding some keys may also be useful.
  22
  23 : (global-set-key (kbd "<f6>") 'spray-mode)
  24
  25 ** Commands
  26
  27 In spray-mode buffers, following commands are available.
  28
  29 - =spray-start/stop= (SPC) ::
  30      pause or resume spraying
  31
  32 - =spray-backward-word= (h, <left>) ::
  33      pause and back to the last word
  34
  35 - =spray-forward-word= (l, <right>) ::
  36      inverse of =spray-backward-word=
  37
  38 Press any key else to quit =spray-mode=.
  39
  40 ** Customization
  41
  42 You may customize spray by modifying following items:
  43
  44 - [Variable] spray-wpm
  45 - [Variable] spray-height
  46 - [Keymap] spray-mode-map
  47 - [Face] spray-base-face
  48 - [Face] spray-orp-face