Go to file
2017-01-30 16:22:50 +01:00
autostart/systemd Update fenrir.service 2016-11-16 14:10:03 +01:00
config Update settings.conf.storm 2017-01-30 16:00:36 +01:00
contrib/fenrir-git Updated PKGBUILD stuff. 2016-11-04 17:49:14 -04:00
docu Update development.txt 2016-09-15 16:28:55 +02:00
experimental make setup.py experimental 2016-12-23 16:18:57 +01:00
play zone add demo, load ignore screen again 2017-01-16 23:04:29 +01:00
src Update dummyDriver.py 2017-01-30 16:22:50 +01:00
tools Update fenrir-conf 2016-12-23 12:33:24 +01:00
.gitignore Cleanup more setup.py leftovers and added to gitignore. 2016-10-22 09:59:49 -08:00
Changelog v1.0.txt restructure management files 2016-12-23 16:36:16 +01:00
install.sh remove wrong intention 2016-11-04 21:32:35 +01:00
known bugs.txt restructure management files 2016-12-23 16:36:16 +01:00
LICENCE add licence LGPLv3 2016-12-30 19:54:27 +01:00
Maintainer restructure management files 2016-12-23 16:36:16 +01:00
README.md get rid of spell 2017-01-25 01:10:10 +01:00
TODO v2.0 Update TODO v2.0 2017-01-27 11:59:02 +01:00

fenrir

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. This software is licensed under the LGPL v3 .

requirements (core)

  • linux
  • python3
  • python-evdev
  • 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)

  • "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

installation

  • Archlinux: PKGBUILD in AUR
  • install.sh (there is currently no uninstall)
  • run from git: You can just run the following as root: cd src/fenrir-package/ sudo ./fenrir 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)