fenrir/README.md

30 lines
952 B
Markdown
Raw Normal View History

2016-10-02 02:36:53 -04:00
# fenrir (Alfa)
An TTY screenreader for Linux.
Its an early alpha version. You can test it. It is not recommended for production use. If you want to help just let me know.
2016-07-05 05:16:34 -04:00
# requirements
2016-09-16 04:31:26 -04:00
- linux
- python3
- python-espeak
- python-evdev
- loaded uinput kernel module
2016-09-16 04:31:26 -04:00
Read permission to the following files:
/sys/devices/virtual/tty/tty0/active
/dev/vcsa[1-64]
ReadWrite permission
/dev/input
/dev/uinput
2016-07-07 08:37:10 -04:00
# optional
- sox [its used by default in the generic sound driver for playing sound-icons]
- speech-dispatcher, python3-speechd [to use the speech-dispatcher driver]
- brltty, python-brlapi [for using braille] # (not implemented yet)
- gstreamer [for soundicons via gstreamer] # not working yet
2016-09-30 19:44:36 -04:00
- python-pyenchant for spell check functionality
2016-09-16 05:50:53 -04:00
2016-07-05 05:18:35 -04:00
# installation
2016-10-01 20:43:31 -04:00
Currently there is no setupscript (sorry). But you can just run as root or setup needed permission
cd src/fenrir-package/
sudo ./fenrir.py
2016-10-02 02:36:53 -04:00
Settings are located in the config directory.