Updated README.
This commit is contained in:
parent
cb6b66b400
commit
3191d335a3
70
README.md
70
README.md
@ -1,19 +1,26 @@
|
|||||||
# Fenrir
|
# Fenrir
|
||||||
|
|
||||||
A modern, modular, flexible and fast console screenreader.
|
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.
|
||||||
|
|
||||||
|
|
||||||
# OS Requirements
|
# OS Requirements
|
||||||
|
|
||||||
- Linux (ptyDriver, vcsaDriver, evdevDriver)
|
- Linux (ptyDriver, vcsaDriver, evdevDriver)
|
||||||
- macOS (ptyDriver)
|
- macOS (ptyDriver)
|
||||||
- BSD (ptyDriver)
|
- BSD (ptyDriver)
|
||||||
- Windows (ptyDriver)
|
- Windows (ptyDriver)
|
||||||
|
|
||||||
|
|
||||||
# Core Requirements
|
# Core Requirements
|
||||||
|
|
||||||
- python3 >= 3.3
|
- python3 >= 3.3
|
||||||
- screen, input, speech, sound or braille drivers dependencies see "Features, Drivers, Extras".
|
- screen, input, speech, sound or braille drivers dependencies 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 (This is commonly referred to as python3-evdev by your distribution)
|
- python-evdev >=0.6.3 (This is commonly referred to as python3-evdev by your distribution)
|
||||||
@ -25,7 +32,9 @@ This software is licensed under the LGPL v3.
|
|||||||
2. "ptyDriver" terminal emulation input driver
|
2. "ptyDriver" terminal emulation input driver
|
||||||
- python-pyte
|
- python-pyte
|
||||||
|
|
||||||
|
|
||||||
# Screen Drivers:
|
# Screen Drivers:
|
||||||
|
|
||||||
1. "vcsaDriver" screen driver for linux VCSA devices
|
1. "vcsaDriver" screen driver for linux VCSA devices
|
||||||
- python-dbus
|
- python-dbus
|
||||||
- Read permission to the following files and services:
|
- Read permission to the following files and services:
|
||||||
@ -36,7 +45,9 @@ This software is licensed under the LGPL v3.
|
|||||||
2. "ptyDriver" terminal emulation driver
|
2. "ptyDriver" terminal emulation driver
|
||||||
- python-pyte
|
- python-pyte
|
||||||
|
|
||||||
|
|
||||||
# Speech Drivers:
|
# Speech Drivers:
|
||||||
|
|
||||||
1. "genericDriver" (default) speech driver for sound as subprocess:
|
1. "genericDriver" (default) speech driver for sound as subprocess:
|
||||||
- espeak or espeak-ng
|
- espeak or espeak-ng
|
||||||
2. "espeakDriver" speech driver for Espeak or Espeak-NG:
|
2. "espeakDriver" speech driver for Espeak or Espeak-NG:
|
||||||
@ -47,19 +58,25 @@ This software is licensed under the LGPL v3.
|
|||||||
4. "emacspeakDriver" speech driver for emacspeak
|
4. "emacspeakDriver" speech driver for emacspeak
|
||||||
- emacspeak
|
- emacspeak
|
||||||
|
|
||||||
|
|
||||||
# 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
|
||||||
|
|
||||||
|
|
||||||
# Sound Drivers:
|
# Sound Drivers:
|
||||||
|
|
||||||
1. "genericDriver" (default) sound driver for sound as subprocess:
|
1. "genericDriver" (default) sound driver for sound as subprocess:
|
||||||
- Sox
|
- Sox
|
||||||
2. "gstreamerDriver" sound driver for gstreamer
|
2. "gstreamerDriver" sound driver for gstreamer
|
||||||
- gstreamer >=1.0
|
- gstreamer >=1.0
|
||||||
- GLib
|
- GLib
|
||||||
|
|
||||||
|
|
||||||
# Extras:
|
# Extras:
|
||||||
|
|
||||||
1. spellchecker
|
1. spellchecker
|
||||||
- python-pyenchant
|
- python-pyenchant
|
||||||
- aspell-YourLanguageCode (example aspell-en for us English)
|
- aspell-YourLanguageCode (example aspell-en for us English)
|
||||||
@ -68,18 +85,29 @@ This software is licensed under the LGPL v3.
|
|||||||
3. Modify system volume:
|
3. Modify system volume:
|
||||||
- pyalsaaudio (needs libasound2's headers).
|
- pyalsaaudio (needs libasound2's headers).
|
||||||
|
|
||||||
|
|
||||||
# installation
|
# installation
|
||||||
- Archlinux: PKGBUILD in AUR
|
|
||||||
|
If there is a package for your distrobution of choice, please let us know so we can add it here.
|
||||||
|
|
||||||
|
- Archlinux: PKGBUILD in AUR (fenrir-git recommended)
|
||||||
- PIP: sudo pip install fenrir-screenreader
|
- PIP: sudo pip install fenrir-screenreader
|
||||||
- Manual:
|
- Manual:
|
||||||
- install "espeak" and "sox" with your package manager
|
- install "espeak" and "sox" with your package manager
|
||||||
- sudo pip install -r requirements.txt
|
- sudo pip install -r requirements.txt
|
||||||
- run install.sh and uninstall.sh as root
|
- run install.sh or 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:
|
||||||
if you are in Fenrir Git rootfolder:
|
if you are in Fenrir Git rootfolder:
|
||||||
cd src/fenrir/
|
|
||||||
sudo ./fenrir
|
cd src/fenrir/
|
||||||
|
sudo ./fenrir
|
||||||
|
|
||||||
|
Same thing, but use the daemon so the terminal is not blocked:
|
||||||
|
|
||||||
|
cd src/fenrir/
|
||||||
|
sudo ./fenrir-daemon
|
||||||
|
|
||||||
Settings "settings.conf" is located in the "config" directory or after installation in /etc/fenrir/settings.
|
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.
|
Take care to use drivers from the config matching your installed drivers.
|
||||||
By default it uses:
|
By default it uses:
|
||||||
@ -87,21 +115,37 @@ By default it uses:
|
|||||||
- speech driver: genericDriver (via espeak or espeak-ng, could configured in settings.conf)
|
- speech driver: genericDriver (via espeak or espeak-ng, could configured in settings.conf)
|
||||||
- braille driver: brlttyDriver (WIP)
|
- braille driver: brlttyDriver (WIP)
|
||||||
- input driver: evdevDriver
|
- input driver: evdevDriver
|
||||||
|
|
||||||
|
|
||||||
# Configure pulseaudio
|
# Configure pulseaudio
|
||||||
Pulseaudio by default does only play sound for the user its currently running for. As fenrir is running as root, your local user does not hear the sound and speech produced by fenrir.
|
|
||||||
for this fenrir provides a script to configure pulseaudio to stream the sound played as root to your local user. Last is playing the sound then. This is not a issue of fenrir but this is how pulseaudio works.
|
|
||||||
|
|
||||||
just run the configuration scipt twice (once as user, once as root).
|
Pulseaudio by default only plays sound for the user its currently running for. As fenrir is running as root, your local user does not hear the sound and speech produced by fenrir.
|
||||||
|
for this fenrir provides a script to configure pulseaudio to stream the sound played as root to your local user. This is not a issue of fenrir but this is how pulseaudio works.
|
||||||
|
|
||||||
Run:
|
just run the configuration script twice (once as user, once as root):
|
||||||
configure_pulse.sh
|
|
||||||
sudo configure_pulse.sh
|
|
||||||
|
|
||||||
The script could also be found at /tools/ in git
|
/usr/share/fenrirscreenreader/tools/configure_pulse.sh
|
||||||
|
sudo /usr/share/fenrirscreenreader/tools/configure_pulse.sh
|
||||||
|
|
||||||
|
The script is also located in the tools directory in git
|
||||||
|
|
||||||
|
|
||||||
|
# Configure pipewire
|
||||||
|
|
||||||
|
Pipewire by default only plays sound for the user its currently running for. As fenrir is running as root, your local user does not hear the sound and speech produced by fenrir.
|
||||||
|
for this fenrir provides a script to configure pipewire to stream the sound played as root to your local user. This is not a issue of fenrir but this is how pipewire works.
|
||||||
|
|
||||||
|
just run the configuration script twice (once as user, once as root):
|
||||||
|
|
||||||
|
/usr/share/fenrirscreenreader/tools/configure_pipewire.sh
|
||||||
|
sudo /usr/share/fenrirscreenreader/tools/configure_pipewire.sh
|
||||||
|
|
||||||
|
The script is also located in the tools directory in git
|
||||||
|
|
||||||
# localization
|
# localization
|
||||||
copy fenrir.mo translations file from fenrir/locale/your_language/LC_MESSAGES/fenrir.mo to /usr/share/locale/your_language/LC_MESSAGES/fenrir.mo
|
copy fenrir.mo translations file from fenrir/locale/your_language/LC_MESSAGES/fenrir.mo to /usr/share/locale/your_language/LC_MESSAGES/fenrir.mo
|
||||||
|
|
||||||
|
|
||||||
# Documentation
|
# Documentation
|
||||||
You can see all information on the Wiki:
|
|
||||||
https://wiki.linux-a11y.org/doku.php?id=fenrir_user_manual
|
Here is the [Fenrir Wiki](https://github.com/chrys87/fenrir.wiki). It is currently being updated, so keep checking back. Feel free to help with documentation.
|
||||||
|
Loading…
Reference in New Issue
Block a user