fenrir/README.md

51 lines
1.6 KiB
Markdown
Raw Normal View History

2016-10-01 22:36:53 -08:00
# fenrir (Alfa)
An TTY screenreader for Linux.
2016-11-16 12:02:36 +01:00
Its an early alpha version. You can test it. It is not recommended for production use. In theorie its not limited to linux. but i currently only provide drivers for that because I have no ohter system here. If you want to help or write drivers to make it work on other systems, just let me know.
2016-07-05 11:16:34 +02:00
2016-11-16 12:00:21 +01:00
# requirements (core)
2016-09-16 10:31:26 +02:00
- linux
- python3
- python-evdev
- loaded uinput kernel module
2016-11-16 11:43:44 +01:00
- Read permission to the following files:
- /sys/devices/virtual/tty/tty0/active
- /dev/vcsa[1-64]
- ReadWrite permission
- /dev/input
- /dev/uinput
2016-11-16 12:00:21 +01:00
- speech, sound or braille drivers see "optional (features, drivers)".
2016-07-07 14:37:10 +02:00
2016-11-16 12:00:21 +01:00
# optional (features, drivers)
2016-11-16 11:59:16 +01:00
- "espeak" speech driver:
- python-espeak
- "speechd" speech driver:
- speech-dispatcher
- python-speechd
- brltty braille driver (not implemented yet, WIP):
- brltty (configured and running)
- python-brlapi
- "generic" sound driver:
- sox
- "gstreamer" sound driver
- gstreamer 1.x
- GLib
- spellchecker
- python-pyenchant
- aspell-YourLanguageCode (example aspell-en for us english)
- unix daemon:
- python-daemonize
2016-09-16 11:50:53 +02:00
2016-07-05 11:18:35 +02:00
# installation
2016-11-07 10:49:32 +01:00
- Archlinux: PKGBUILD in AUR
- install.sh (there is currently no uninstall)
- run from git:
You can just run the following as root:
2016-10-02 02:43:31 +02:00
cd src/fenrir-package/
2016-11-07 10:49:32 +01:00
sudo ./fenrir
2016-11-16 11:59:16 +01:00
Settings "settings.conf" is located in the "config" directory.
Take care that the used drivers in the config matching your installed drivers.
By default it uses:
- sound driver: generic (via sox, could configured in settings.conf)
- speech driver: speechd
- braille driver: brltty (WIP)