storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
2,828 Commits 1 Branch 17 Tags 8.5 MiB
Python 87.3%
Roff 9.1%
Shell 3.6%
7e82042661
Go to file
chrys 7e82042661 add remote command for set clipboard
2018-10-26 17:38:02 +02:00
autostart remove systemd file from installation 2018-06-18 00:31:59 +02:00
config Merge branch 'storm' 2018-09-11 02:08:01 +02:00
contrib change contrib structure, prepare rrpm, update AUR 2017-07-25 10:29:58 +02:00
docu fix some bad stuff 2018-07-21 02:04:44 +02:00
experimental/selinux make setup.py initial work 2017-05-25 13:43:33 +02:00
locale Added a polish translation 2018-10-23 16:53:43 +02:00
play zone folder restructuring 2018-09-11 02:43:03 +02:00
realese nots add release notes 2018-09-23 00:40:29 +02:00
src add remote command for set clipboard 2018-10-26 17:38:02 +02:00
tools fix ignore/ungignore 2018-09-21 17:32:55 +02:00
.gitignore remove stalled stuff 2017-10-20 22:10:55 +02:00
bugs folder restructuring 2018-09-11 02:43:03 +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-09-25 15:58:35 +02:00
setup.py raise version 2018-09-11 21:37:40 +02:00
TODO v2.0 Merge branch 'bleed' 2018-09-23 00:46:15 +02:00
TODOv3.0 folder restructuring 2018-09-11 02:43:03 +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.

OS Requirements

  • Linux (ptyDriver, vcsaDriver, evdevDriver)
  • macOS (ptyDriver)
  • BSD (ptyDriver)
  • Windows (ptyDriver)

Core Requirements

  • python3 >= 3.3
  • screen, input, speech, sound or braille drivers dependencies see "Features, Drivers, Extras".

Features, Drivers, Extras, Dependencies

Input Drivers:

  1. "evdevDriver" input driver for linux evdev
  • python-evdev >=0.6.3 (This is commonly referred to as python3-evdev by your distribution)
  • python-pyudev
  • 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

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. "emacspeakDriver" speech driver for emacspeak
  • emacspeak

Braille Drivers:

  1. "BrlttyDriver" braille driver (WIP):
  • brltty (configured and running)
  • python-brlapi

Sound Drivers:

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

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
  • PIP: sudo pip install fenrir-screenreader
  • 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