commit e21b8afd9f3529a7e125cc8038dd0bdc503435b2
parent 17e68196bd380bbe147b8225165d5485396a6ba7
Author: Yuval Langer <yuval.langer@gmail.com>
Date: Sun, 18 Jun 2023 21:30:40 +0300
Update README.md file.
Diffstat:
| M | README.md | | | 77 | +++++++++++++++++++++-------------------------------------------------------- |
1 file changed, 21 insertions(+), 56 deletions(-)
diff --git a/README.md b/README.md
@@ -5,71 +5,35 @@
Mark some text
and let it rip.
-Not a fancy curiosity but an accessibility tool for people with reading
-disabilities. I use it every day to read.
+Not a fancy curiosity but an accessibility tool for people with
+reading disabilities. I use it every day to read.
It basically reads whatever you mark with your mouse cursor.
## "Community":
-<irc://libera.chat/clipboard-speaker> (on the web: <https://web.libera.chat/#clipboard-speaker>).
+<irc://libera.chat/clipboard-speaker> (on the web:
+<https://web.libera.chat/#clipboard-speaker>).
## Code repositories:
-Main development repository is on codeberg.org:
+Main development repository is on <https://sr.ht/>:
-https://git.sr.ht/~kakafarm/guile-clipboard-speaker/
+<https://git.sr.ht/~kakafarm/guile-clipboard-speaker/>
Mirrors:
-* https://codeberg.org/yuvallangerontheroad/guile-clipboard-speaker/
-* https://gitlab.com/yuvallangerontheroad/guile-clipboard-speaker/
-* https://gitlab.com/yuvallanger/guile-clipboard-speaker/
+* <https://codeberg.org/yuvallangerontheroad/guile-clipboard-speaker/>
+* <https://gitlab.com/yuvallangerontheroad/guile-clipboard-speaker/>
+* <https://gitlab.com/yuvallanger/guile-clipboard-speaker/>
## Changelog:
Have a look at the <a href="CHANGELOG.md">CHANGELOG.md</a> file.
-## Newer Python version:
+## Map your keybindings:
-### Installation:
-
-#### Dependencies:
-
-* GNU Guile
-* https://github.com/espeak-ng/espeak-ng/
-* https://github.com/kfish/xsel
-
-#### Install the Dependencies:
-
-##### On Debian based systems:
-
-`apt install espeak-ng xsel python3`
-
-#### Install the script files:
-
-##### Manually:
-
-Copy the two executable scripts into your home bin directory:
-
-```
-cp clipboard_speaker/clipboard_speaker.py ~/bin/clipboard-speaker
-cp clipboard_speaker/clipboard_speaker_kill.py ~/bin/clipboard-speaker-kill
-```
-
-##### pip:
-
-```
-pip install --user .
-```
-
-After which the script files are located, at least here in my system, under
-`~/.local/bin/` as `~/.local/bin/clipboard-speak` and
-`~/.local/bin/clipboard-speak-kill`.
-
-#### Map your keybindings:
-
-##### On Gnome:
+### On Gnome:
Add the key bindings in (if you use Gnome. If you don't, look up how to
assign scripts to keybindings in your own window manager):
@@ -80,15 +44,16 @@ Gnome Settings
→ All the way down and press the + button
```
-### Usage:
+## Usage:
1. Select some text. While the text is highlighted,
-2. press the keybinding assigned to the `clipboard-reader` executable to start
- the reading of the highlighted text.
-3. (optional, while `clipboard-speaker` is reading the text) Select some more
- text and press the keybinding that starts `clipboard-reader`. The selected
- text will be added to the text buffer and will be read right after the last
- bunch of text.
+2. press the keybinding assigned to the `clipboard-reader` executable
+ to start the reading of the highlighted text.
+3. (optional, while `clipboard-speaker` is reading the text) Select
+ some more text and press the keybinding that starts
+ `clipboard-reader`. The selected text will be added to the text
+ buffer and will be read right after the last bunch of text.
4. (optional) GOTO 3.
-5. (optional) Press the other keybinding assigned to the `clipboard-reader-kill`
- script to make your computer stop speaking and clear the text buffer.
+5. (optional) Press the other keybinding assigned to the
+ `clipboard-reader --kill` script to make your computer stop
+ speaking and clear the text buffer.
