Fixed lots of grammatical errors, install scripts using -f for copy to avoid errors whilst installing.
This commit is contained in:
26
README.md
26
README.md
@ -1,10 +1,10 @@
|
||||
# Fenrir
|
||||
A TTY screenreader for Linux.
|
||||
In theory it's not just limited to Linux. but i currently only provide drivers for that since I do not have another system here. If you want to help or write drivers to make it work on other systems, just let me know.
|
||||
In theory it's not just limited to Linux. but i currently only provide drivers for that since I do not have another system here. 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 (currently only screen and input drivers available for that)
|
||||
- Linux (currently only screen and input drivers available)
|
||||
- python3 >= 3.3
|
||||
- python-configargparse
|
||||
- screen, input, speech, sound or braille drivers see "Features, Drivers, Extras".
|
||||
@ -30,32 +30,32 @@ This software is licensed under the LGPL v3 .
|
||||
- read logind DBUS
|
||||
|
||||
# Speech Drivers:
|
||||
1. "espeakDriver" speech driver for espeak:
|
||||
1. "EspeakDriver" speech driver for Espeak:
|
||||
- python-espeak
|
||||
- "speechdDriver" speech driver for speech-dispatcher:
|
||||
- speech-dispatcher
|
||||
- "speechdDriver" speech driver for Speech-dispatcher:
|
||||
- Speech-dispatcher
|
||||
- python-speechd
|
||||
2. "dummyDriver" speech driver for debugging
|
||||
|
||||
# Braille Drivers:
|
||||
1. "brlttyDriver" braille driver (WIP):
|
||||
1. "BrlttyDriver" braille driver (WIP):
|
||||
- brltty (configured and running)
|
||||
- python-brlapi
|
||||
2. "dummyDriver" braille driver for debugging
|
||||
2. "dummyDriver" Braille driver for debugging
|
||||
|
||||
# Sound Drivers:
|
||||
1. "genericDriver" sound driver for sound as subprocess:
|
||||
- sox
|
||||
- Sox
|
||||
2. "gstreamerDriver" sound driver for gstreamer
|
||||
- gstreamer >=1.0
|
||||
- GLib
|
||||
3. "dummyDriver" sound driver for debugging
|
||||
|
||||
# Extra:
|
||||
# Extras:
|
||||
1. spellchecker
|
||||
- python-pyenchant
|
||||
- aspell-YourLanguageCode (example aspell-en for us english)
|
||||
2. unix daemon (also needed for systemd):
|
||||
- aspell-YourLanguageCode (example aspell-en for us English)
|
||||
2. Unix daemon (also needed for Systemd):
|
||||
- python-daemonize
|
||||
3. Modify system volume:
|
||||
- pyalsaaudio (needs libasound2's headers).
|
||||
@ -69,7 +69,7 @@ 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 that the used drivers in the config matching your installed drivers.
|
||||
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: speechdDriver
|
||||
@ -77,5 +77,5 @@ By default it uses:
|
||||
- input driver: evdevDriver
|
||||
|
||||
# Documentation
|
||||
You can see all information in the wiki:
|
||||
You can see all information on the Wiki:
|
||||
https://wiki.linux-a11y.org/doku.php?id=fenrir_user_manual&s[]=fenrir
|
||||
|
Reference in New Issue
Block a user