Updated README.
This commit is contained in:
Storm Dragon
parent
d70073274b
commit
8782d53d03
57
README.md
57
README.md
@ -5,7 +5,7 @@ It should run on any operating system. If you want to help, or write drivers to
|
||||
This software is licensed under the LGPL v3.
|
||||
|
||||
|
||||
# OS Requirements
|
||||
## OS Requirements
|
||||
|
||||
- Linux (ptyDriver, vcsaDriver, evdevDriver)
|
||||
- macOS (ptyDriver)
|
||||
@ -13,15 +13,15 @@ This software is licensed under the LGPL v3.
|
||||
- Windows (ptyDriver)
|
||||
|
||||
|
||||
# Core Requirements
|
||||
## Core Requirements
|
||||
|
||||
- python3 >= 3.3
|
||||
- screen, input, speech, sound 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
|
||||
- python-evdev >=0.6.3 (This is commonly referred to as python3-evdev by your distribution)
|
||||
- python-pyudev
|
||||
@ -33,7 +33,7 @@ This software is licensed under the LGPL v3.
|
||||
- python-pyte
|
||||
|
||||
|
||||
# Screen Drivers:
|
||||
### Screen Drivers:
|
||||
|
||||
1. "vcsaDriver" screen driver for linux VCSA devices
|
||||
- python-dbus
|
||||
@ -46,20 +46,18 @@ This software is licensed under the LGPL v3.
|
||||
- python-pyte
|
||||
|
||||
|
||||
# Speech Drivers:
|
||||
### 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:
|
||||
2. "speechdDriver" speech driver for Speech-dispatcher:
|
||||
- Speech-dispatcher
|
||||
- python-speechd
|
||||
4. "emacspeakDriver" speech driver for emacspeak
|
||||
3. "emacspeakDriver" speech driver for emacspeak
|
||||
- emacspeak
|
||||
|
||||
|
||||
# Sound Drivers:
|
||||
### Sound Drivers:
|
||||
|
||||
1. "genericDriver" (default) sound driver for sound as subprocess:
|
||||
- Sox
|
||||
@ -68,7 +66,7 @@ This software is licensed under the LGPL v3.
|
||||
- GLib
|
||||
|
||||
|
||||
# Extras:
|
||||
## Extras:
|
||||
|
||||
1. spellchecker
|
||||
- python-pyenchant
|
||||
@ -79,28 +77,23 @@ This software is licensed under the LGPL v3.
|
||||
- pyalsaaudio (needs libasound2's headers).
|
||||
|
||||
|
||||
# installation
|
||||
## installation
|
||||
|
||||
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
|
||||
- Archlinux: PKGBUILD in AUR
|
||||
- fenrir: stable release
|
||||
- fenrir-git: Bleeding edge release
|
||||
- Manual:
|
||||
- install "espeak" and "sox" with your package manager
|
||||
- sudo pip install -r requirements.txt
|
||||
- run install.sh or 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:
|
||||
- install "espeak" and "sox" with your package manager
|
||||
- sudo pip install -r requirements.txt
|
||||
- run install.sh or uninstall.sh as root
|
||||
- You can also just run it from Git without installing:
|
||||
Requires root privileges
|
||||
|
||||
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.
|
||||
Take care to use drivers from the config matching your installed drivers.
|
||||
By default it uses:
|
||||
@ -109,7 +102,7 @@ By default it uses:
|
||||
- input driver: evdevDriver
|
||||
|
||||
|
||||
# Configure pulseaudio
|
||||
## Configure pulseaudio
|
||||
|
||||
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.
|
||||
@ -122,7 +115,7 @@ just run the configuration script twice (once as user, once as root):
|
||||
The script is also located in the tools directory in git
|
||||
|
||||
|
||||
# Configure pipewire
|
||||
## 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.
|
||||
@ -134,10 +127,12 @@ just run the configuration script twice (once as user, once as root):
|
||||
|
||||
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
|
||||
|
||||
|
||||
# Documentation
|
||||
## Documentation and Support
|
||||
|
||||
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.
|
||||
- Email list: [stormux+subscribe@groups.io](mailto:stormux+subscribe@groups.io?subject=subscribe) with the subject subscribe.
|
||||
- [Fenrir Wiki](https://git.stormux.org/storm/fenrir/wiki)
|
||||
- IRC: irc.stormux.org #stormux
|
||||
|
||||
@ -4,5 +4,5 @@
|
||||
# Fenrir TTY screen reader
|
||||
# By Chrys, Storm Dragon, and contributers.
|
||||
|
||||
version = "2024.12.09"
|
||||
version = "2024.12.10"
|
||||
codeName = "testing"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user