Go to file

Jeremiah Ticket a5606afe8d add \o/ to emoticons		2017-03-22 15:43:31 -08:00
autostart/systemd	Update fenrir.service	2016-11-16 14:10:03 +01:00
config	add \o/ to emoticons	2017-03-22 15:43:31 -08: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	improve docu	2017-03-19 00:41:56 +01:00
locale/es/LC_MESSAGES	Updated spanish translation	2017-02-26 17:02:13 -06:00
play zone	Update charmapTTY.py	2017-03-22 15:58:28 +01:00
src	Updated description of hilight command for tutorial mode.	2017-03-19 15:50:00 -08:00
tools	Updated translation template	2017-02-26 22:19:55 +00: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	fix ln for bin folder	2017-03-16 23:51:22 +01:00
known bugs.txt	Update known bugs.txt	2017-02-28 16:57:00 +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	Added python3-evdev statement to README as users are still accidently installing python2 evdev.	2017-03-12 12:18:36 +11:00
TODO v2.0	add tutorial list to ToDo	2017-03-10 18:25:58 +01:00
uninstall.sh	Merge branch 'master' of github.com:chrys87/fenrir	2017-03-18 22:51:04 +01:00

README.md

Fenrir

A TTY screenreader for Linux. In theory it's not just limited to Linux. but i currently only provide drivers for that since I do not have another 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 (currently only screen and input drivers available for that)
python3 >= 3.3
python-configargparse
screen, input, speech, sound or braille drivers see "Features, Drivers, Extras".

Features, Drivers, Extras, Dependencys

Input Drivers:

"evdevDriver" input driver for linux evdev

python-evdev >=0.6.3
This is commonly referred to as python3-evdev by your distribution
- loaded uinput kernel module
- ReadWrite permission
  - /dev/input
  - /dev/uinput

Screen Drivers:

"vcsaDriver" screen driver for linux VCSA devices

python-dbus
Read permission to the following files and services:
- /sys/devices/virtual/tty/tty0/active
- /dev/vcsa[1-64]
- read systemd DBUS

Speech Drivers:

"espeakDriver" speech driver for espeak:

python-espeak
"speechdDriver" speech driver for speech-dispatcher:
- speech-dispatcher
- python-speechd

"dummyDriver" speech driver for debugging

Braille Drivers:

"brlttyDriver" braille driver (WIP):

brltty (configured and running)
python-brlapi

"dummyDriver" braille driver for debugging

Sound Drivers:

"genericDriver" sound driver for sound as subprocess:

"gstreamerDriver" sound driver for gstreamer

gstreamer >=1.0
GLib

"dummyDriver" sound driver for debugging

Extra:

spellchecker

python-pyenchant
aspell-YourLanguageCode (example aspell-en for us english)

unix daemon (also needed for systemd):

python-daemonize

Modify system volume:

pyalsaaudio (needs libasound2's headers).

installation

Archlinux: PKGBUILD in AUR
Manual: run install.sh and uninstall.sh as root
you also can just run it from Git without installing: You can just run the following as root: if you are in Fenrir Git rootfolder: cd src/fenrir/ sudo ./fenrir Settings "settings.conf" is located in the "config" directory or after installation in /etc/fenrir/settings. Take care that the used drivers in the config matching your installed drivers. By default it uses:
sound driver: genericDriver (via sox, could configured in settings.conf)
speech driver: speechdDriver
braille driver: brlttyDriver (WIP)
input driver: evdevDriver