Fixed lots of grammatical errors, install scripts using -f for copy to avoid errors whilst installing.
This commit is contained in:
Rob Whyte
parent
64dedaf960
commit
8cf405bad1
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
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
ToDo list for Fenrir Version 1.5
|
||||
Things with not so deep knowledge needed are marekd wiht "(Easy for contribution)". so just start with that :).
|
||||
Things with not so much knowledge needed are marekd wiht "(Easy for contribution)". so just start with that :).
|
||||
|
||||
Fix Bugs:
|
||||
- device detection is broken
|
||||
|
||||
2
bugs
2
bugs
@ -1,7 +1,7 @@
|
||||
Please report Bugs and feature requests to:
|
||||
https://github.com/chrys87/fenrir/issues
|
||||
|
||||
for bugs please provide a debug file that shows the issue.
|
||||
For bugs, please provide a debug file that shows the issue.
|
||||
How to create a debug file:
|
||||
1. first delete old stuff:
|
||||
sudo rm /var/log/fenrir.log
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
|
||||
Keymap for fenrir
|
||||
Keymap for Fenrir
|
||||
KEY_RESERVED
|
||||
KEY_ESC
|
||||
KEY_1
|
||||
|
||||
@ -6,7 +6,7 @@ enabled=True
|
||||
# Sox is the default.
|
||||
driver=genericDriver
|
||||
|
||||
# Sound themes. This is the pack of sounds used for sound alerts.
|
||||
# Sound themes. These are the pack of sounds used for sound alerts.
|
||||
# Sound packs may be located at /usr/share/sounds
|
||||
# For system wide availability, or ~/.local/share/fenrir/sounds
|
||||
# For the current user.
|
||||
@ -24,7 +24,7 @@ volume=1.0
|
||||
# fenrirDuration = the duration of the frequence
|
||||
# the following command is used for play a soundfile
|
||||
genericPlayFileCommand=play -q -v fenrirVolume fenrirSoundFile 2>/dev/null
|
||||
#the following command is used for generating a frequence beep
|
||||
#the following command is used for generating a frequency beep
|
||||
genericFrequencyCommand=play -q -v fenrirVolume -n -c1 synth fenrirDuration sine fenrirFrequence 2>/dev/null
|
||||
|
||||
[speech]
|
||||
@ -37,7 +37,7 @@ enabled=True
|
||||
driver=espeakDriver
|
||||
|
||||
|
||||
# The rate selects how fast fenrir will speak. Options range from 0, slowest, to 1.0, fastest.
|
||||
# The rate selects how fast Fenrir will speak. Options range from 0, slowest, to 1.0, fastest.
|
||||
rate=0.35
|
||||
|
||||
# Pitch controls the pitch of the voice, select from 0, lowest, to 1.0, highest.
|
||||
@ -48,16 +48,16 @@ capitalPitch=0.9
|
||||
# Volume controls the loudness of the voice, select from 0, quietest, to 1.0, loudest.
|
||||
volume=1.0
|
||||
|
||||
# Module is used for speech-dispatcher, to select the speech module you want to use.
|
||||
# Consult speech-dispatcher's configuration and help ti find out which modules are available.
|
||||
# The default is espeak.
|
||||
# Module is used for Speech-dispatcher, to select the speech module you want to use.
|
||||
# Consult Speech-dispatcher's configuration and help ti find out which modules are available.
|
||||
# The default is Espeak.
|
||||
module=espeak
|
||||
|
||||
# Voice selects the varient you want to use, for example, f5 will use the female voice #5 in espeak,
|
||||
# or if using the espeak module in speech-dispatcher. To find out which voices are available, consult the documentation provided with your chosen synthesizer.
|
||||
# Voice selects the varient you want to use, for example, f5 will use the female voice #5 in Espeak,
|
||||
# or if using the Espeak module in Speech-dispatcher. To find out which voices are available, consult the documentation provided with your selected synthesizer.
|
||||
voice=f3
|
||||
|
||||
# Select the language you want fenrir to use.
|
||||
# Select the language you want Fenrir to use.
|
||||
language=en_US
|
||||
|
||||
# Read new text as it happens?
|
||||
@ -66,7 +66,7 @@ autoReadIncoming=True
|
||||
# genericSpeechCommand is the command that is executed for talking
|
||||
# the following variables are replaced with values
|
||||
# fenrirText = is the text that should be spoken
|
||||
# fenrirModule = may be the speech module like used in speech-dispatcher, not every TTY need this
|
||||
# fenrirModule = may be the speech module used in Speech-dispatcher, not every TTY needs this
|
||||
# fenrirLanguage = the language
|
||||
# fenrirVoice = is the current voice that should be used
|
||||
# the current volume, pitch and rate is calculated like this
|
||||
@ -76,7 +76,7 @@ autoReadIncoming=True
|
||||
# fenrirRate = is replaced with the current speed (speech rate)
|
||||
genericSpeechCommand=espeak -a fenrirVolume -s fenrirRate -p fenrirPitch -v fenrirVoice "fenrirText"
|
||||
|
||||
# those are the min and max values of the TTS system that is used in genericSpeechCommand
|
||||
# these are the minimum and maximum values of the TTS system used in genericSpeechCommand
|
||||
fenrirMinVolume=0
|
||||
fenrirMaxVolume=200
|
||||
fenrirMinPitch=0
|
||||
@ -126,7 +126,7 @@ autodetectSuspendingScreen=True
|
||||
driver=evdevDriver
|
||||
# filter input devices NOMICE, ALL or a DEVICE NAME
|
||||
device=ALL
|
||||
# gives fenrir exclusive access to the keyboard and let consume keystrokes.
|
||||
# gives Fenrir exclusive access to the keyboard and let consume keystrokes.
|
||||
grabDevices=True
|
||||
ignoreShortcuts=False
|
||||
# the current shortcut layout located in /etc/fenrir/keyboard
|
||||
@ -156,7 +156,7 @@ numberOfClipboards=10
|
||||
# $user is replaced by username
|
||||
clipboardExportPath=/tmp/fenrirClipboard
|
||||
emoticons=True
|
||||
# define the current fenrir key
|
||||
# define the current Fenrir key
|
||||
fenrirKeys=KEY_KP0,KEY_META
|
||||
scriptKey=KEY_COMPOSE
|
||||
timeFormat=%H:%M:%P
|
||||
|
||||
@ -7,7 +7,7 @@ enabled=True
|
||||
#driver=gstreamerDriver
|
||||
driver=genericDriver
|
||||
|
||||
# Sound themes. This is the pack of sounds used for sound alerts.
|
||||
# Sound themes. These are the pack of sounds used for sound alerts.
|
||||
# Sound packs may be located at /usr/share/sounds
|
||||
# For system wide availability, or ~/.local/share/fenrir/sounds
|
||||
# For the current user.
|
||||
@ -21,8 +21,8 @@ volume=1.0
|
||||
# the folowing variable are substituted
|
||||
# fenrirVolume = the current volume setting
|
||||
# fenrirSoundFile = the soundfile for an soundicon
|
||||
# fenrirFrequence = the frequence to play
|
||||
# fenrirDuration = the duration of the frequence
|
||||
# fenrirFrequence = the frequency to play
|
||||
# fenrirDuration = the duration of the frequency
|
||||
# the following command is used to play a soundfile
|
||||
genericPlayFileCommand=play -q -v fenrirVolume fenrirSoundFile
|
||||
#the following command is used to generate a frequency beep
|
||||
@ -49,13 +49,13 @@ capitalPitch=0.9
|
||||
# Volume controls the loudness of the voice, select from 0, quietest, to 1.0, loudest.
|
||||
volume=1.0
|
||||
|
||||
# Module is used for speech-dispatcher, to select the speech module you want to use.
|
||||
# Consult speech-dispatcher's configuration and help Fenrir find out which modules are available.
|
||||
# Module is used for Speech-dispatcher, to select the speech module you want to use.
|
||||
# Consult Speech-dispatcher's configuration and help Fenrir find out which modules are available.
|
||||
# The default is espeak.
|
||||
module=espeak
|
||||
|
||||
# Voice selects the varient you want to use, for example, f5 will use the female voice #5 in espeak,
|
||||
# or if using the espeak module in speech-dispatcher. To find out which voices are available, consult the documentation provided with your selected synthesizer.
|
||||
# Voice selects the varient you want to use, for example, f5 will use the female voice #5 in Espeak,
|
||||
# or if using the Espeak module in Speech-dispatcher. To find out which voices are available, consult the documentation provided with your selected synthesizer.
|
||||
# This also sets the voice used in the generic driver.
|
||||
voice=
|
||||
|
||||
@ -162,7 +162,7 @@ numberOfClipboards=10
|
||||
#clipboardExportPath=/home/$user/fenrirClipboard
|
||||
clipboardExportPath=/tmp/fenrirClipboard
|
||||
emoticons=True
|
||||
# define the current fenrir key
|
||||
# define the current Fenrir key
|
||||
fenrirKeys=KEY_KP0,KEY_META,KEY_INSERT
|
||||
scriptKey=KEY_COMPOSE
|
||||
timeFormat=%H:%M:%P
|
||||
|
||||
@ -34,7 +34,7 @@ autoReadIncoming=True
|
||||
# fenrirRate = is replaced with the current speed (speech rate)
|
||||
genericSpeechCommand=espeak -a fenrirVolume -s fenrirRate -p fenrirPitch -v fenrirVoice "fenrirText"
|
||||
|
||||
# those are the min and max values of the TTS system that is used in genericSpeechCommand
|
||||
# these are the min and max values of the TTS system that is used in genericSpeechCommand
|
||||
fenrirMinVolume=0
|
||||
fenrirMaxVolume=200
|
||||
fenrirMinPitch=0
|
||||
|
||||
24
install.sh
24
install.sh
@ -1,20 +1,20 @@
|
||||
#!/bin/bash
|
||||
#Basic install script for Fenrir.
|
||||
read -p "This will install Fenrir. Press ctrl+c to cancel, or enter to continue." continue
|
||||
read -p "This will install Fenrir. Press ctrl+C to cancel, or enter to continue." continue
|
||||
|
||||
# fenrir main application
|
||||
# Fenrir main application
|
||||
install -m755 -d /opt/fenrir
|
||||
cp -a src/fenrir/* /opt/fenrir
|
||||
cp -af src/fenrir/* /opt/fenrir
|
||||
install -m644 -D "autostart/systemd/fenrir.service" /usr/lib/systemd/system/fenrir.service
|
||||
ln -s /opt/fenrir/fenrir-daemon /usr/bin/fenrir-daemon
|
||||
ln -s /opt/fenrir/fenrir /usr/bin/fenrir
|
||||
ln -fs /opt/fenrir/fenrir-daemon /usr/bin/fenrir-daemon
|
||||
ln -fs /opt/fenrir/fenrir /usr/bin/fenrir
|
||||
# tools
|
||||
install -m755 -d /usr/share/fenrir/tools
|
||||
cp -a tools/* /usr/share/fenrir/tools
|
||||
cp -af tools/* /usr/share/fenrir/tools
|
||||
|
||||
# scripts
|
||||
install -m755 -d /usr/share/fenrir/scripts
|
||||
cp -a "config/scripts/wlan__-__key_y.sh" /usr/share/fenrir/scripts/
|
||||
cp -af "config/scripts/wlan__-__key_y.sh" /usr/share/fenrir/scripts/
|
||||
|
||||
# keyboard
|
||||
install -m644 -D "config/keyboard/desktop.conf" /etc/fenrir/keyboard/desktop.conf
|
||||
@ -22,13 +22,13 @@ install -m644 -D "config/keyboard/laptop.conf" /etc/fenrir/keyboard/laptop.conf
|
||||
|
||||
# punctuation
|
||||
install -m755 -d /etc/fenrir/punctuation
|
||||
cp -a config/punctuation/* /etc/fenrir/punctuation
|
||||
cp -af config/punctuation/* /etc/fenrir/punctuation
|
||||
|
||||
# sound
|
||||
install -d /usr/share/sounds/fenrir
|
||||
cp -a config/sound/default /usr/share/sounds/fenrir/default
|
||||
cp -a config/sound/default-wav /usr/share/sounds/fenrir/default-wav
|
||||
cp -a config/sound/template /usr/share/sounds/fenrir/template
|
||||
cp -af config/sound/default /usr/share/sounds/fenrir/default
|
||||
cp -af config/sound/default-wav /usr/share/sounds/fenrir/default-wav
|
||||
cp -af config/sound/template /usr/share/sounds/fenrir/template
|
||||
|
||||
# config
|
||||
if [ -f "/etc/fenrir/settings/settings.conf" ]; then
|
||||
@ -59,5 +59,5 @@ sudo systemctl enable fenrir
|
||||
|
||||
Pulseaudio users may want to run
|
||||
/usr/share/fenrir/tools/configure-pulseaudio
|
||||
once as their user account, then once as root.
|
||||
once from their user account, then once from the root.
|
||||
EOF
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
#!/bin/bash
|
||||
|
||||
# This script configures pulse to work both in the graphical invironment and in the console with root apps.
|
||||
# This script configures Pulse to work both in the graphical environment and in the console with root apps.
|
||||
|
||||
if [[ $(whoami) != "root" ]]; then
|
||||
# Get the current user's XDG_HOME
|
||||
@ -67,8 +67,8 @@ fi
|
||||
|
||||
# If there were no errors tell user to restart, else warn them errors happened.
|
||||
if [ $? -eq 0 ]; then
|
||||
echo "Configuration created successfully, restart pulse, or your system, for changes to take affect."
|
||||
echo "Configuration created successfully, please restart Pulseaudio or your system, for changes to take affect."
|
||||
else
|
||||
echo "Errors were encountered while writing the configuration. please correct them manually."
|
||||
echo "Errors were encountered whilst writing the configuration, please correct them manually."
|
||||
fi
|
||||
exit 0
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
# Get user input args are return variable, question, options
|
||||
get_input()
|
||||
{
|
||||
# Variable names are long, cause I want absolutely no name conflicts.
|
||||
# Variable names are long, because we want absolutely no name conflicts.
|
||||
local __get_input_input=$1
|
||||
shift
|
||||
local __get_input_question="$1"
|
||||
@ -42,7 +42,7 @@ exit 1
|
||||
fi
|
||||
|
||||
if [ -f "$configFile" ]; then
|
||||
read -p "This will replace your current settings. Press enter to continue or control+c to abort." continue
|
||||
read -p "This will replace your current settings, press enter to continue or control+C to abort." continue
|
||||
fi
|
||||
|
||||
get_input sound "Enable sound?" -yes no
|
||||
@ -69,7 +69,7 @@ enabled=$sound
|
||||
# Sox is the default.
|
||||
driver=$soundDriver
|
||||
|
||||
# Sound themes. This is the pack of sounds used for sound alerts.
|
||||
# Sound themes. These are the pack of sounds used for sound alerts.
|
||||
# Sound packs may be located at /usr/share/sounds
|
||||
# For system wide availability, or ~/.local/share/fenrir/sounds
|
||||
# For the current user.
|
||||
@ -80,14 +80,14 @@ theme=default
|
||||
volume=1.0
|
||||
|
||||
# shell commands for generic sound driver
|
||||
# the folowing variable are substituded
|
||||
# the folowing variables are substituted
|
||||
# fenrirVolume = the current volume setting
|
||||
# fenrirSoundFile = the soundfile for an soundicon
|
||||
# fenrirFrequence = the frequence to play
|
||||
# fenrirDuration = the duration of the frequence
|
||||
# fenrirDuration = the duration of the frequency
|
||||
# the following command is used for play a soundfile
|
||||
genericPlayFileCommand=play -q -v fenrirVolume fenrirSoundFile
|
||||
#the following command is used for generating a frequence beep
|
||||
#the following command is used for generating a frequency beep
|
||||
genericFrequencyCommand=play -q -v fenrirVolume -n -c1 synth fenrirDuration sine fenrirFrequence
|
||||
|
||||
[speech]
|
||||
@ -98,7 +98,7 @@ enabled=$speech
|
||||
driver=$speechDriver
|
||||
|
||||
|
||||
# The rate selects how fast fenrir will speak. Options range from 0, slowest, to 1.0, fastest.
|
||||
# The rate selects how fast Fenrir will speak. Options range from 0, slowest, to 1.0, fastest.
|
||||
rate=0.45
|
||||
|
||||
# Pitch controls the pitch of the voice, select from 0, lowest, to 1.0, highest.
|
||||
@ -109,23 +109,23 @@ capitalPitch=0.9
|
||||
# Volume controls the loudness of the voice, select from 0, quietest, to 1.0, loudest.
|
||||
volume=1.0
|
||||
|
||||
# Module is used for speech-dispatcher, to select the speech module you want to use.
|
||||
# Consult speech-dispatcher's configuration and help ti find out which modules are available.
|
||||
# The default is espeak.
|
||||
# Module is used for Speech-dispatcher, to select the speech module you want to use.
|
||||
# Consult Speech-dispatcher's configuration and help to find out which modules are available.
|
||||
# The default is Espeak.
|
||||
module=espeak
|
||||
|
||||
# Voice selects the varient you want to use, for example, f5 will use the female voice #5 in espeak,
|
||||
# or if using the espeak module in speech-dispatcher. To find out which voices are available, consult the documentation provided with your chosen synthesizer.
|
||||
# or if using the espeak module in Speech-dispatcher. To find out which voices are available, consult the documentation provided with your selected synthesizer.
|
||||
voice=
|
||||
|
||||
# Select the language you want fenrir to use.
|
||||
# Select the language you want Fenrir to use.
|
||||
language=english-us
|
||||
|
||||
# Read new text as it happens?
|
||||
autoReadIncoming=True
|
||||
|
||||
[braille]
|
||||
#braille is not implemented yet
|
||||
#Braille is not implemented yet
|
||||
enabled=False
|
||||
driver=brlapi
|
||||
layout=en
|
||||
@ -139,7 +139,7 @@ autodetectSuspendingScreen=True
|
||||
driver=evdev
|
||||
# filter input devices NOMICE, ALL or a DEVICE NAME
|
||||
device=ALL
|
||||
# gives fenrir exclusive access to the keyboard and let consume keystrokes.
|
||||
# gives Fenrir exclusive access to the keyboard and lets it absorb keystrokes.
|
||||
grabDevices=True
|
||||
ignoreShortcuts=False
|
||||
# the current shortcut layout located in /etc/fenrir/keyboard
|
||||
@ -152,7 +152,7 @@ charDeleteEcho=True
|
||||
wordEcho=$wordEcho
|
||||
# interrupt speech on any keypress
|
||||
interruptOnKeyPress=$enterupt
|
||||
# you can filter the keys on that the speech should interrupt (empty = all keys, otherwhise the given keys)
|
||||
# you can filter the keys that the speech should interrupt (empty = all keys, otherwise the given keys)
|
||||
interruptOnKeyPressFilter=
|
||||
# timeout for double tap in sec
|
||||
doubleTapTimeout=0.2
|
||||
@ -169,7 +169,7 @@ respectPunctuationPause=True
|
||||
newLinePause=True
|
||||
numberOfClipboards=10
|
||||
emoticons=True
|
||||
# define the current fenrir key
|
||||
# define the current Fenrir key
|
||||
fenrirKeys=KEY_KP0,KEY_META,KEY_INSERT
|
||||
scriptKey=KEY_COMPOSE
|
||||
timeFormat=%H:%M:%P
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
#!/bin/bash
|
||||
#Basic uninstall script for fenrir.
|
||||
#Basic uninstall script for Fenrir.
|
||||
cat << EOF
|
||||
Fenrir is going to remove.
|
||||
All scripts and settings will be lost.
|
||||
EOF
|
||||
|
||||
# ask
|
||||
read -p "This will remove fenrir and settings. Press ctrl+c to cancel, or enter to continue." continue
|
||||
read -p "This will remove Fenrir and settings, press ctrl+C to cancel, or enter to continue." continue
|
||||
|
||||
# do it
|
||||
unlink /usr/bin/fenrir
|
||||
|
||||
Loading…
Reference in New Issue
Block a user