storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1,261 Commits 1 Branch 17 Tags 8.5 MiB
Python 87.3%
Roff 9.1%
Shell 3.6%
d70c8e2032
Go to file
chrys87 d70c8e2032 Update README.md
2016-11-07 10:49:32 +01:00
autostart/systemd Updated fenrir.service to play a little bit nicer with restarts and reloads, and updated setup.py as python-espeak is no longer found in pipi. 2016-10-19 08:47:47 -08:00
config add espeak settings template 2016-11-05 17:07:21 +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
play zone cleanup move demo application to play zone 2016-10-19 23:56:53 +02:00
src correct default path if scriptpath is not available in settings.conf 2016-11-05 17:54:16 +01:00
tools announce toggle of Numlock, Capslock and Scrolllock 2016-10-22 20:27:58 +02:00
.gitignore Cleanup more setup.py leftovers and added to gitignore. 2016-10-22 09:59:49 -08:00
install.sh remove wrong intention 2016-11-04 21:32:35 +01:00
README.md Update README.md 2016-11-07 10:49:32 +01:00
setup.py Updated fenrir.service to play a little bit nicer with restarts and reloads, and updated setup.py as python-espeak is no longer found in pipi. 2016-10-19 08:47:47 -08:00
TODO marks hilighted mode as done 2016-11-05 00:20:27 +01:00

README.md

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.

requirements

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

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 [using braille] # (not implemented yet)
  • gstreamer [soundicons via gstreamer] # not working yet
  • python-pyenchant [spell check functionality]
  • aspell- [your languagedata for spellchecker, english support "aspell-en"]
  • python-daemonize [use fenrir as background service on Unix like systems]

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 are located in the "config" directory.