storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
2,726 Commits 2 Branches 19 Tags 8.9 MiB
Python 96.7%
Shell 3.3%
0887adc905
Go to file
chrys 0887adc905 remove spaces
2018-07-19 21:20:32 +02:00
autostart remove systemd file from installation 2018-06-18 00:31:59 +02:00
config add shut_up_pty 2018-07-17 00:25:21 +02:00
contrib change contrib structure, prepare rrpm, update AUR 2017-07-25 10:29:58 +02:00
docs remove spaces 2018-07-19 21:20:32 +02:00
experimental/selinux make setup.py initial work 2017-05-25 13:43:33 +02:00
locale Added Brazilian Portuguese translations, thanks to Roberta Santos. 2018-07-11 20:12:35 -04:00
play-zone remove spaces 2018-07-19 21:20:32 +02:00
releasenotes remove spaces 2018-07-19 21:20:32 +02:00
src add shut_up_pty 2018-07-17 00:25:21 +02:00
tools fix missing renames 2018-06-18 00:22:16 +02:00
.gitignore remove stalled stuff 2017-10-20 22:10:55 +02:00
bugs Fixed lots of grammatical errors, install scripts using -f for copy to avoid errors whilst installing. 2017-08-12 20:38:03 +10:00
change-dir-name.patch remove spaces 2018-07-19 21:20:32 +02:00
change-whitespace-to-dash.patch remove spaces 2018-07-19 21:20:32 +02:00
check-dependencies.py fix dependency check 2018-06-08 23:53:52 +02:00
CREDITS Credits file updated. 2018-06-10 20:33:27 -04:00
install.sh remove systemd file from installation 2018-06-18 00:31:50 +02:00
LICENCE add licence LGPLv3 2016-12-30 19:54:27 +01:00
README.md Update README.md 2018-06-08 10:41:32 +02:00
setup.py update shellbang of setup.py 2018-07-17 00:41:16 +02:00
TODO-v2.0 remove spaces 2018-07-19 21:20:32 +02:00
TODO-v3.0 remove spaces 2018-07-19 21:20:32 +02:00
uninstall.sh Update uninstall.sh 2018-06-12 11:36:52 +02:00

README.md

Fenrir

A modern, modular, flexible and fast console screenreader. It should run on any operating system. 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 (ptyDriver, vcsaDriver, evdevDriver)

  • macOS (ptyDriver)

  • BSD (ptyDriver)

  • Windows (ptyDriver)

  • python3 >= 3.3

  • python-configargparse

  • screen, input, speech, sound or braille drivers see "Features, Drivers, Extras".

Features, Drivers, Extras, Dependencies

Input Drivers:

  1. "evdevDriver" input driver for linux evdev
  • python-evdev >=0.6.3
  • python-pyudev
  1. This is commonly referred to as python3-evdev by your distribution
  • loaded uinput kernel module
  • ReadWrite permission
    • /dev/input
    • /dev/uinput
  1. "ptyDriver" terminal emulation input driver
  • python-pyte

Screen Drivers:

  1. "vcsaDriver" screen driver for linux VCSA devices
  • python-dbus
  • Read permission to the following files and services:
    • /sys/devices/virtual/tty/tty0/active
    • /dev/tty[1-64]
    • /dev/vcsa[1-64]
    • read logind DBUS
  1. "ptyDriver" terminal emulation driver
  • python-pyte
  1. "dummyDriver" just a dummy

Speech Drivers:

  1. "genericDriver" (default) speech driver for sound as subprocess:
  • espeak or espeak-ng
  1. "espeakDriver" speech driver for Espeak or Espeak-NG:
  • python-espeak
  1. "speechdDriver" speech driver for Speech-dispatcher:
  • Speech-dispatcher
  • python-speechd
  1. "dummyDriver" no speech
  2. "debugDriver" speech driver for debugging

Braille Drivers:

  1. "BrlttyDriver" braille driver (WIP):
  • brltty (configured and running)
  • python-brlapi
  1. "dummyDriver" (default) no braille
  2. "debugDriver" Braille driver for debugging

Sound Drivers:

  1. "genericDriver" (default) sound driver for sound as subprocess:
  • Sox
  1. "gstreamerDriver" sound driver for gstreamer
  • gstreamer >=1.0
  • GLib
  1. "dummyDriver" no sound
  2. "debugDriver" sound driver for debugging

Extras:

  1. spellchecker
  • python-pyenchant
  • aspell-YourLanguageCode (example aspell-en for us English)
  1. Unix daemon (also needed for Systemd):
  • python-daemonize
  1. 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 to use drivers from the config matching your installed drivers. By default it uses:
  • sound driver: genericDriver (via sox, could configured in settings.conf)
  • speech driver: genericDriver (via espeak or espeak-ng, could configured in settings.conf)
  • braille driver: brlttyDriver (WIP)
  • input driver: evdevDriver

Documentation

You can see all information on the Wiki: https://wiki.linux-a11y.org/doku.php?id=fenrir_user_manual