README.org

   1 * Intro
   2
   3 This is a minor mode helping user speed-reading. Similar with Spritz (speed read).
   4
   5 The core code is borrowed from "Spray".
   6
   7 * Screencast
   8
   9 [[file:scroll-by-word.gif]]
  10
  11 [[file:scroll-by-line.gif]]
  12
  13 * Features
  14
  15 - [X] interactive select scroll style by word or line at first time
  16 - [X] resume from the position where stopped
  17 - [X] scroll by word or line reading interactively
  18 - [X] speed up/down scroll
  19 - [X] pause/resume from position
  20 - [X] support Chinese context
  21   - [X] 自动内容分词，将分词作为一个 word, 在分词的结果上进行移动，这个办法太复
  22     杂了，直接将行长度作为字符串长度考虑来计算停留时间。
  23 - [X] line style scroll by smart timer speed based on current and next line text length
  24 - [X] support customize overlay face font and color
  25 - [X] support reading highlighted text (word,line) with cross-platform TTS Speech API or command-line voice tools.
  26   + cross-platform TTS Speech API
  27   + macOS: "=say="
  28   + GNU/Linux: "=espeak=", "=festival="
  29   + Microsoft Windows: TTS
  30
  31 * Installation
  32
  33 MELPA available soon.
  34
  35 #+begin_src emacs-lisp
  36 (use-package amread-mode
  37   :ensure t
  38   :commands (amread-mode))
  39 #+end_src
  40
  41 * Usage
  42
  43 1. start amread-mode with command =[M-x amread]=.
  44
  45 2. amread-mode will ask you use which scroll style? scroll by word or scroll by line.
  46
  47    #+NAME: scroll by word
  48    [[file:scroll-by-word.gif]]
  49
  50    #+NAME: scroll by line
  51    [[file:scroll-by-line.gif]]
  52
  53 3. keybindings in amread reading status:
  54    * stop amread-mode minor mode by pressing =[q]=.
  55    * press =[SPACE]= to pause or resume.
  56    * press =[+/-]= to change speed.
  57    * press =[v]= to toggle voice reading.
  58