Odilia is a screen reader for the Linux desktop. It's written in Rust, for maximum performance and stability.
This is absolutely not production ready in any way!
Everything is in a fairly early stage and we're changing things on a daily basis.
However, Odilia is somewhat useable, and will not crash randomly or cause weird behaviour in other applications.
Try it out! See if it works for you!
Perhaps unnecessarily, but you will need to have speech-dispatcher installed and running before you can start Odilia.
to test that speech dispatcher is indeed working properly, try running this command:
shell
spd-say "hello, world!"
if you heard a voice saying "hello, world!", you can proceed to installing. Otherwise, check if sound is working on the computer in general, try looking for error outputs especially in the logs, then consult your distro packagers and ask them about how it's supposed to be set up and what could be wrong, perhaps you have to do something else before it's fully workingh, for example adding yourself to a speech group or other distro specific mechanisms
To build odilia, copy paste the following on your command line . The following snippet will clone, build and install it for you, all at once without user interaction. The final binaries will be located in ~/.cargo/bin
shell
git clone https://github.com/odilia-app/odilia && \
cd odilia && \
cargo build --release && \
cargo install --path odilia
This script will populate /etc/odilia with several configuration files, which are required for the well functioning of the screenreader. You have to run it as root because it has to write to /etc, which is protected from regular user access, no other reasons are involved
shell
sudo ./scripts/install_configs.sh
You will also want to compile and install sohkd. (Copy and paste the following on your command line. )
shell
cd sohkd && \
cargo build --release && \
cargo install --path .
To run Odilia, you should use our script. This will ask for your password (if you have root permissions) and then launch both Odilia and the hotkey daemon in quiet mode.
shell
./scripts/odilia
You can find us in the following places:
We are excited to accept new contributions to this project; in fact, we already have! Sometimes there may be missing documentation or lack of examples. Please, reach out to us, make an issue, or a pull request and we will continue to improve Odilia with your help. By the way, a huge thank you to all who have contributed so far, and who will continue to do so in the future!
We do not have any specific contribution guidelines or codes of conduct for now, however most likely these will be fleshed out as Odilia matures more.
If you'd like detailed performance benchmarks, we recommend using the flamegraph package to show performance bottlenecks.
There is also hotspot, a C++ program available in the AUR, and some major package repos, which can display how much time is spent in various portions of the program in an accessible (GUI) way.
First, install the subcommand with:
bash
$ cargo install flamegraph
If needed, install Hotspot from the AUR/your package repo, as well as perf which is required to produce the flame graph.
bash
$ paru/yay -S hotspot perf
Finally, add the following to the root Cargo.toml:
toml
[profile.bench]
debug = true
Now, you can run the following commands to produce flamegraphes for individual benchmarks with the following command:
bash
cargo flamegraph --bench load_test -- --bench [individual_bench_name]
The Odilia screen reader is licensed under the GPL v3.