Updated README. Bumped version to 0.2.
This commit is contained in:
13
README.md
13
README.md
@ -65,3 +65,16 @@ within Cthulhu.
|
||||
So, you want to write a script for Cthulhu? The best thing to do is
|
||||
start by looking at other scripts under the src/cthulhu/scripts/ hierarchy
|
||||
of the source tree. Cthulhu also has an excellent plugin system, more documentation and examples coming soon.
|
||||
|
||||
## Self-voicing
|
||||
|
||||
Cthulhu offers a mechanism through which messages may be spoken directly by the screen reader. Usage is as follows:
|
||||
|
||||
```bash
|
||||
# Speak hello world.
|
||||
echo "Hello world." | socat - UNIX-CLIENT:/tmp/cthulhu.sock
|
||||
# Speak Hello world without interrupting the previous speech.
|
||||
echo "<!#APPEND#!>Hello world." | socat - UNIX-CLIENT:/tmp/cthulhu.sock
|
||||
# Make hello world persistant in Braille.
|
||||
echo "Hello world.<#APPEND#>" | socat - UNIX-CLIENT:/tmp/cthulhu.sock
|
||||
```
|
||||
|
Reference in New Issue
Block a user