README.md (3159B)
1 # Clipboard Speaker. 2 3 Want your computer 4 to speak a bit? 5 Mark some text 6 and let it rip. 7 8 Not a fancy curiosity but an accessibility tool for people with reading 9 disabilities. I use it every day to read. 10 11 It basically reads whatever you mark with your mouse cursor. 12 13 ## Code repositories: 14 15 Main development repository is on codeberg.org: 16 17 https://git.sr.ht/~kakafarm/clipboard-speaker/ 18 19 Mirrors: 20 21 * https://codeberg.org/yuvallangerontheroad/clipboard-speaker/ 22 * https://gitlab.com/yuvallangerontheroad/clipboard-speaker/ 23 * https://github.com/yuvallangerontheroad/clipboard-speaker/ 24 * https://gitlab.com/yuvallanger/clipboard-speaker/ 25 * https://github.com/yuvallanger/clipboard-speaker/ 26 27 ## Changelog: 28 29 Have a look at the <a href="CHANGELOG.md">CHANGELOG.md</a> file. 30 31 ## Newer Python version: 32 33 ### Installation: 34 35 #### Dependencies: 36 37 * https://python.org/ 38 * https://github.com/espeak-ng/espeak-ng/ 39 * https://github.com/kfish/xsel 40 41 #### Install the Dependencies: 42 43 ##### On Debian based systems: 44 45 `apt install espeak-ng xsel python3` 46 47 #### Install the script files: 48 49 ##### Manually: 50 51 Copy the two executable scripts into your home bin directory: 52 53 ``` 54 cp clipboard_speaker/clipboard_speaker.py ~/bin/clipboard-speaker 55 cp clipboard_speaker/clipboard_speaker_kill.py ~/bin/clipboard-speaker-kill 56 ``` 57 58 ##### pip: 59 60 ``` 61 pip install --user . 62 ``` 63 64 After which the script files are located, at least here in my system, under 65 `~/.local/bin/` as `~/.local/bin/clipboard-speak` and 66 `~/.local/bin/clipboard-speak-kill`. 67 68 #### Map your keybindings: 69 70 ##### On Gnome: 71 72 Add the key bindings in (if you use Gnome. If you don't, look up how to 73 assign scripts to keybindings in your own window manager): 74 75 ``` 76 Gnome Settings 77 → Keyboard Shortcuts 78 → All the way down and press the + button 79 ``` 80 81 ### Usage: 82 83 1. Select some text. While the text is highlighted, 84 2. press the keybinding assigned to the `clipboard-reader` executable to start 85 the reading of the highlighted text. 86 3. (optional, while `clipboard-speaker` is reading the text) Select some more 87 text and press the keybinding that starts `clipboard-reader`. The selected 88 text will be added to the text buffer and will be read right after the last 89 bunch of text. 90 4. (optional) GOTO 3. 91 5. (optional) Press the other keybinding assigned to the `clipboard-reader-kill` 92 script to make your computer stop speaking and clear the text buffer. 93 94 ## Older shell version: 95 96 ### Dependencies: 97 98 * http://software.clapper.org/daemonize/ 99 * https://github.com/espeak-ng/espeak-ng/ 100 * https://github.com/kfish/xsel 101 102 ### Installation: 103 104 1. Install the dependencies: 105 `apt install daemonize espeak-ng xsel` 106 2. Copy the two executable scripts into your home bin directory: 107 `cp clipboard-speaker clipboard-speaker-kill ~/bin/` 108 3. Add the key bindings in: 109 `Gnome Settings → Keyboard Shortcuts → All the way down and press the + button` 110 111 ### Usage: 112 113 1. Select some text. 114 2. Press the keybinding to start `clipboard-reader`. Your computer is now speaking the stuff in the selection. 115 3. (optional) Press the other keybinding to start `clipboard-reader-kill` and make computer stop speaking.