README.md 2.94 KB
Newer Older
Joanmarie Diggs's avatar
Joanmarie Diggs committed
1
# Orca v42.alpha
William Walker's avatar
William Walker committed
2

3
## Introduction
William Walker's avatar
William Walker committed
4

William Walker's avatar
William Walker committed
5
6
Orca is a free, open source, flexible, and extensible screen reader
that provides access to the graphical desktop via user-customizable
7
combinations of speech and/or braille.
William Walker's avatar
William Walker committed
8
9
10
11
12
13

Orca works with applications and toolkits that support the assistive
technology service provider interface (AT-SPI), which is the primary
assistive technology infrastructure for the Solaris and Linux
operating environments.  Applications and toolkits supporting the
AT-SPI include the GNOME GTK+ toolkit, the Java platform's Swing
Joanmarie Diggs's avatar
Joanmarie Diggs committed
14
15
toolkit, OpenOffice/LibreOffice, Gecko, and WebKitGtk.  AT-SPI support
for the KDE Qt toolkit is currently being pursued.
William Walker's avatar
William Walker committed
16

Joanmarie Diggs's avatar
Joanmarie Diggs committed
17
18
19
See also <http://wiki.gnome.org/Projects/Orca> for detailed information
on Orca, including how to run Orca, how to communicate with the Orca user
community, and where to log bugs and feature requests.
20
21

## Dependencies
William Walker's avatar
William Walker committed
22

Joanmarie Diggs's avatar
Joanmarie Diggs committed
23
Orca v42.x is supported on GNOME 42.x only.  We highly suggest you
William Walker's avatar
William Walker committed
24
25
use the latest releases of GNOME because they contain accessibility
infrastructure and application bug fixes that help Orca work better.
William Walker's avatar
William Walker committed
26

27
Orca also has the following dependencies:
William Walker's avatar
William Walker committed
28

29
* Python 3         - Python platform
30
* pygobject-3.0    - Python bindings for the GObject library
Piotr Drąg's avatar
Piotr Drąg committed
31
* gtk+-3.0         - GTK+ toolkit
32
* json-py          - a JSON (<https://json.org/>) reader and writer in Python
Joanmarie Diggs's avatar
Joanmarie Diggs committed
33
* python-speechd   - Python bindings for Speech Dispatcher (optional)
34
* BrlTTY           - BrlTTY (<https://mielke.cc/brltty/>) support for braille (optional)
William Walker's avatar
William Walker committed
35
* BrlAPI           - BrlAPI support for braille (optional)
36
* liblouis         - Liblouis (<http://liblouis.org/>) support for contracted braille (optional)
37
* py-setproctitle  - Python library to set the process title (optional)
38
* gstreamer-1.0    - GStreamer - Streaming media framework (optional)
Marc Mulcahy's avatar
Marc Mulcahy committed
39

40
You are strongly encouraged to also have the latest stable versions
Joanmarie Diggs's avatar
Joanmarie Diggs committed
41
of AT-SPI2 and ATK for the GNOME 42.x release.
42

William Walker's avatar
William Walker committed
43

44
## NOTE FOR BRLTTY USERS:
William Walker's avatar
William Walker committed
45

Joanmarie Diggs's avatar
Joanmarie Diggs committed
46
Orca depends upon the Python bindings for BrlAPI available in BrlTTY v4.5
Willie Walker's avatar
Willie Walker committed
47
or better.  You can determine if the Python bindings for BrlAPI are
William Walker's avatar
William Walker committed
48
49
installed by running the following command:

50
```sh
William Walker's avatar
William Walker committed
51
python -c "import brlapi"
52
```
William Walker's avatar
William Walker committed
53

Joanmarie Diggs's avatar
Joanmarie Diggs committed
54
If you get an error, the Python bindings for BrlAPI are not installed.
55

56
## Running Orca
William Walker's avatar
William Walker committed
57

Joanmarie Diggs's avatar
Joanmarie Diggs committed
58
59
If you wish to modify your Orca preferences, you can press "Insert+space"
while Orca is running.
William Walker's avatar
William Walker committed
60

Joanmarie Diggs's avatar
Joanmarie Diggs committed
61
To get help while running Orca, press "Insert+H".  This will enable
Joanmarie Diggs's avatar
Joanmarie Diggs committed
62
63
64
65
66
67
"learn mode", which provides a spoken and brailled description of what
various keyboard and braille input device actions will do.  To exit
learn mode, press "Escape."  Finally, the preferences dialog contains
a "Key Bindings" tab that lists the keyboard binding for Orca.

For more information, see the Orca documentation which is available
68
within Orca as well as at: <https://help.gnome.org/users/orca/stable/>
William Walker's avatar
William Walker committed
69

70
## Scripting Orca
71
72
73

So, you want to write a script for Orca?  The best thing to do is 
start by looking at other scripts under the src/orca/scripts/ hierarchy
74
of the source tree.