Odilia屏幕阅读器

欢迎来到Odilia

Odilia是Linux桌面的屏幕阅读器。它使用Rust编写，以实现最佳性能和稳定性。

状态：测试版

这绝对不是任何方式下的生产就绪！
一切都很早期，我们每天都在改变。然而，Odilia 某种程度上 可用，并且不会随机崩溃或导致其他应用程序出现奇怪行为。
试试看！看看它是否适合您！

先决条件

Odilia的MSRV是1.65。

在您开始使用Odilia之前，您需要安装并运行speech-dispatcher。为了测试语音调度器是否确实正常运行，请尝试运行以下命令

spd-say "hello, world!"

如果您听到一个声音说“你好，世界！”，则可以继续安装。否则，请检查计算机是否一般可以发出声音。

构建和安装

要构建Odilia，请在命令行上复制粘贴以下内容。以下代码将为您一次性克隆、构建并安装它，无需用户交互。最终的二进制文件将位于~/.cargo/bin

git clone https://github.com/odilia-app/odilia  && \
cd odilia && \
cargo build --release && \
cargo install --path odilia

运行

只需在您的终端中键入odilia！

社区

您可以在以下地方找到我们

• Discord
• IRC: irc.libera.chat
  • #odilia-dev（开发）
  • #odilia（通用）
  • #odilia-offtopic（非主题）
• Matrix: stealthy.club
  • #odilia-dev（开发）
  • #odilia（通用）
  • #odilia-offtopic（非主题）

贡献

我们非常高兴接受对这个项目的新的贡献；实际上，我们已经有了！有时可能会缺少文档或缺少示例。请，联系我们，创建一个问题，或者一个拉取请求，我们将继续在您的帮助下改进Odilia。顺便说一句，非常感谢迄今为止已经做出贡献的所有人，以及将来将继续做出贡献的所有人！

目前我们没有具体的贡献指南或行为准则，然而，随着Odilia的成熟，这些可能将被完善。

性能基准测试

如果您想获取详细性能基准，我们建议使用 flamegraph 包来显示性能瓶颈。还有 hotspot，一个在 AUR 和一些主要软件仓库中可用的 C++ 程序，它可以以直观（GUI）的方式显示程序各部分花费的时间。

首先，使用以下命令安装子命令：

$ cargo install flamegraph

如果需要，从 AUR/您的软件仓库安装 Hotspot，以及 perf，它是生成火焰图所必需的。

$ paru/yay -S hotspot perf

最后，将以下内容添加到根目录的 Cargo.toml

[profile.bench]
debug = true

现在，您可以使用以下命令为单个基准生成火焰图：

cargo flamegraph --bench load_test -- --bench [individual_bench_name]

许可证

Odilia 屏幕阅读器根据 GPL v3 许可。