storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
chrys87 2017-01-30 16:45:01 +01:00 committed by GitHub
parent fbb05b8ec9
commit 72e6ee271b
1 changed files with 33 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,35 +1,46 @@
# fenrir # Fenrir
An TTY screenreader for Linux. An TTY screenreader for Linux.
In theorie its not limited to linux. but i currently only provide drivers for that because I do not have an ohter system here. If you want to help or write drivers to make it work on other systems, just let me know. In theorie its not limited to linux. but i currently only provide drivers for that because I do not have an ohter system here. If you want to help or write drivers to make it work on other systems, just let me know.
This software is licensed under the LGPL v3 . This software is licensed under the LGPL v3 .
# requirements (core) # requirements (core)
- linux - linux (currently only screen and input drivers available for that)
- python3 - python3 >= 3.3
- python-evdev - screen, input, speech, sound or braille drivers see "features, drivers".
- loaded uinput kernel module
- Read permission to the following files:
- /sys/devices/virtual/tty/tty0/active
- /dev/vcsa[1-64]
- ReadWrite permission
- /dev/input
- /dev/uinput
- speech, sound or braille drivers see "optional (features, drivers)".
# optional (features, drivers) # features, drivers
- "espeak" speech driver: Input Drivers:
- "evdevDriver" input driver for linux evdev
- python-evdev
- loaded uinput kernel module
- ReadWrite permission
- /dev/input
- /dev/uinput
Screen Drivers:
- "vcsaDriver" screen driver for linux VCSA devices
- Read permission to the following files:
- /sys/devices/virtual/tty/tty0/active
- /dev/vcsa[1-64]
Speech Drivers:
- "espeakDriver" speech driver for espeak:
- python-espeak - python-espeak
- "speechd" speech driver: - "speechdDriver" speech driver for speech-dispatcher:
- speech-dispatcher - speech-dispatcher
- python-speechd - python-speechd
- brltty braille driver (not implemented yet, WIP): - "dummyDriver" speech driver for debugging
Braille Drivers:
- "brlttyDriver" braille driver (WIP):
- brltty (configured and running) - brltty (configured and running)
- python-brlapi - python-brlapi
- "generic" sound driver: - "dummyDriver" braille driver for debugging
Sound Drivers:
- "genericDriver" sound driver for sound as subprocess:
- sox - sox
- "gstreamer" sound driver - "gstreamerDriver" sound driver for gstreamer
- gstreamer 1.x - gstreamer 1.x
- GLib - GLib
- "dummyDriver" sound driver for debugging
Extra:
- spellchecker - spellchecker
- python-pyenchant - python-pyenchant
- aspell-YourLanguageCode (example aspell-en for us english) - aspell-YourLanguageCode (example aspell-en for us english)
@ -46,6 +57,7 @@ sudo ./fenrir
Settings "settings.conf" is located in the "config" directory. Settings "settings.conf" is located in the "config" directory.
Take care that the used drivers in the config matching your installed drivers. Take care that the used drivers in the config matching your installed drivers.
By default it uses: By default it uses:
- sound driver: generic (via sox, could configured in settings.conf) - sound driver: genericDriver (via sox, could configured in settings.conf)
- speech driver: speechd - speech driver: speechdDriver
- braille driver: brltty (WIP) - braille driver: brlttyDriver (WIP)
- input driver: evdevDriver