No Description

chrys 453869e9af fix some bad stuff 3 weeks ago
autostart d554fb4bf3 remove systemd file from installation 2 months ago
config bc8bba12cc fix some bad stuff 3 weeks ago
contrib bdb366d9c3 change contrib structure, prepare rrpm, update AUR 1 year ago
docu 453869e9af fix some bad stuff 3 weeks ago
experimental e39a5b301c make setup.py initial work 1 year ago
locale bd8906ddc9 Added Brazilian Portuguese translations, thanks to Roberta Santos. 1 month ago
play zone 453869e9af fix some bad stuff 3 weeks ago
realese nots 453869e9af fix some bad stuff 3 weeks ago
src 453869e9af fix some bad stuff 3 weeks ago
tools d926858aeb fix missing renames 2 months ago
.gitignore 1b559ef722 remove stalled stuff 10 months ago
CREDITS 5c66426f26 Credits file updated. 2 months ago
Changelog.txt 453869e9af fix some bad stuff 3 weeks ago
LICENCE dd8f7e05f9 add licence LGPLv3 1 year ago
README.md 85ec5d22ea Update README.md 2 months ago
TODO v2.0 453869e9af fix some bad stuff 3 weeks ago
TODOv3.0 453869e9af fix some bad stuff 3 weeks ago
bugs 8cf405bad1 Fixed lots of grammatical errors, install scripts using -f for copy to avoid errors whilst installing. 1 year ago
check-dependencies.py 547c9302b0 fix dependency check 2 months ago
install.sh 6c5fb412ed remove systemd file from installation 2 months ago
setup.py bc8bba12cc fix some bad stuff 3 weeks ago
splits.txt 453869e9af fix some bad stuff 3 weeks ago
uninstall.sh dc7d8229a3 Update uninstall.sh 2 months ago

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
  2. This is commonly referred to as python3-evdev by your distribution
    • loaded uinput kernel module
    • ReadWrite permission
    • /dev/input
    • /dev/uinput
  3. "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
  2. "ptyDriver" terminal emulation driver
    • python-pyte
  3. "dummyDriver" just a dummy

Speech Drivers:

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

Braille Drivers:

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

Sound Drivers:

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

Extras:

  1. spellchecker
    • python-pyenchant
    • aspell-YourLanguageCode (example aspell-en for us English)
  2. Unix daemon (also needed for Systemd):
    • python-daemonize
  3. 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