storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
2,646 Commits 1 Branch 17 Tags 8.5 MiB
Python 87.3%
Roff 9.1%
Shell 3.6%
558651f9d1
Go to file
chrys 558651f9d1 Merge branch 'master' into bleed
2018-06-09 11:06:22 +02:00
autostart systemd 2018-04-11 23:57:28 +02:00
config add toggle sink-a 2018-06-08 23:46:09 +02:00
contrib change contrib structure, prepare rrpm, update AUR 2017-07-25 10:29:58 +02:00
docu Revert "Merge branch 'master' of github.com:chrys87/fenrir" 2018-03-09 15:28:07 +01:00
experimental/selinux make setup.py initial work 2017-05-25 13:43:33 +02:00
locale Proofreading, thanks Jenny 2017-12-27 22:44:35 +01:00
play zone add toggle sink-a 2018-06-08 23:44:07 +02:00
src add toggle sink-a 2018-06-08 23:44:07 +02:00
tools add toggle sink-a 2018-06-08 23:46:09 +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
Changelog.txt add changelog 2017-10-02 21:30:06 +02:00
check-dependencies.py fix dependency check 2018-06-08 23:53:52 +02:00
install.sh remove opus files 2018-03-26 08:01:37 +02:00
known bugs.txt clean up version 2018-06-05 00:29:50 +02: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 Update README.md 2018-06-08 10:41:32 +02:00
setup.py improve output for pdmenu 2018-06-08 20:44:33 +02:00
TODO v2.0 sync 2018-06-04 07:25:28 +02:00
TODOv3.0 sync 2018-05-31 00:04:50 +02:00
uninstall.sh replaces namespace fenrir with fenrirscreenreader 2018-03-21 11:10:12 +01: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