storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
chrys 2018-09-15 20:03:00 +02:00 committed by GitHub
parent fd8fcbdb8f
commit 242684b138
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -3,27 +3,26 @@ 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. 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. This software is licensed under the LGPL v3.
# Requirements (core) OS Requirements
- Linux (ptyDriver, vcsaDriver, evdevDriver) - Linux (ptyDriver, vcsaDriver, evdevDriver)
- macOS (ptyDriver) - macOS (ptyDriver)
- BSD (ptyDriver) - BSD (ptyDriver)
- Windows (ptyDriver) - Windows (ptyDriver)
# Core Requirements
- python3 >= 3.3 - python3 >= 3.3
- python-configargparse - screen, input, speech, sound or braille drivers dependencies see "Features, Drivers, Extras".
- screen, input, speech, sound or braille drivers see "Features, Drivers, Extras".
# Features, Drivers, Extras, Dependencies # Features, Drivers, Extras, Dependencies
# Input Drivers: # Input Drivers:
1. "evdevDriver" input driver for linux evdev 1. "evdevDriver" input driver for linux evdev
- python-evdev >=0.6.3 - python-evdev >=0.6.3 (This is commonly referred to as python3-evdev by your distribution)
- python-pyudev - python-pyudev
2. This is commonly referred to as python3-evdev by your distribution
- loaded uinput kernel module - loaded uinput kernel module
- ReadWrite permission - ReadWrite permission
- /dev/input - /dev/input
- /dev/uinput - /dev/uinput
3. "ptyDriver" terminal emulation input driver 2. "ptyDriver" terminal emulation input driver
- python-pyte - python-pyte
# Screen Drivers: # Screen Drivers:
@ -36,7 +35,6 @@ This software is licensed under the LGPL v3.
- read logind DBUS - read logind DBUS
2. "ptyDriver" terminal emulation driver 2. "ptyDriver" terminal emulation driver
- python-pyte - python-pyte
3. "dummyDriver" just a dummy
# Speech Drivers: # Speech Drivers:
1. "genericDriver" (default) speech driver for sound as subprocess: 1. "genericDriver" (default) speech driver for sound as subprocess:
@ -46,15 +44,11 @@ This software is licensed under the LGPL v3.
3. "speechdDriver" speech driver for Speech-dispatcher: 3. "speechdDriver" speech driver for Speech-dispatcher:
- Speech-dispatcher - Speech-dispatcher
- python-speechd - python-speechd
4. "dummyDriver" no speech
5. "debugDriver" speech driver for debugging
# Braille Drivers: # Braille Drivers:
1. "BrlttyDriver" braille driver (WIP): 1. "BrlttyDriver" braille driver (WIP):
- brltty (configured and running) - brltty (configured and running)
- python-brlapi - python-brlapi
2. "dummyDriver" (default) no braille
3. "debugDriver" Braille driver for debugging
# Sound Drivers: # Sound Drivers:
1. "genericDriver" (default) sound driver for sound as subprocess: 1. "genericDriver" (default) sound driver for sound as subprocess:
@ -62,8 +56,6 @@ This software is licensed under the LGPL v3.
2. "gstreamerDriver" sound driver for gstreamer 2. "gstreamerDriver" sound driver for gstreamer
- gstreamer >=1.0 - gstreamer >=1.0
- GLib - GLib
3. "dummyDriver" no sound
4. "debugDriver" sound driver for debugging
# Extras: # Extras:
1. spellchecker 1. spellchecker
@ -76,6 +68,7 @@ This software is licensed under the LGPL v3.
# installation # installation
- Archlinux: PKGBUILD in AUR - Archlinux: PKGBUILD in AUR
- PIP: sudo pip install fenrir-screenreader
- Manual: run install.sh and uninstall.sh as root - Manual: run install.sh and uninstall.sh as root
- you also can just run it from Git without installing: - you also can just run it from Git without installing:
You can just run the following as root: You can just run the following as root: