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:
chrys87 2016-11-16 11:59:16 +01:00 committed by GitHub
parent 2e1e7f1413
commit ed9fbcf9e4
1 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -5,7 +5,6 @@ Its an early alpha version. You can test it. It is not recommended for productio
# requirements # requirements
- linux - linux
- python3 - python3
- python-espeak
- python-evdev - python-evdev
- loaded uinput kernel module - loaded uinput kernel module
- Read permission to the following files: - Read permission to the following files:
@ -14,16 +13,27 @@ Its an early alpha version. You can test it. It is not recommended for productio
- ReadWrite permission - ReadWrite permission
- /dev/input - /dev/input
- /dev/uinput - /dev/uinput
- speech, sound or braille drivers see optional featrues.
# optional # optional by feature
- sox [its used by default in the generic sound driver for playing sound-icons] - "espeak" speech driver:
- speech-dispatcher, python3-speechd [to use the speech-dispatcher driver] - python-espeak
- brltty, python-brlapi [using braille] # (not implemented yet) - "speechd" speech driver:
- gstreamer [soundicons via gstreamer] - speech-dispatcher
- GLib [soundicons via gstreamer] - python-speechd
- python-pyenchant [spell check functionality] - brltty braille driver (not implemented yet, WIP):
- aspell-<language> [your languagedata for spellchecker, english support "aspell-en"] - brltty (configured and running)
- python-daemonize [use fenrir as background service on Unix like systems] - python-brlapi
- "generic" sound driver:
- sox
- "gstreamer" sound driver
- gstreamer 1.x
- GLib
- spellchecker
- python-pyenchant
- aspell-YourLanguageCode (example aspell-en for us english)
- unix daemon:
- python-daemonize
# installation # installation
- Archlinux: PKGBUILD in AUR - Archlinux: PKGBUILD in AUR
@ -32,5 +42,9 @@ Its an early alpha version. You can test it. It is not recommended for productio
You can just run the following as root: You can just run the following as root:
cd src/fenrir-package/ cd src/fenrir-package/
sudo ./fenrir sudo ./fenrir
Settings are located in the "config" directory. Settings "settings.conf" is located in the "config" directory.
Take care that the used drivers in the config matching your installed drivers.
By default it uses:
- sound driver: generic (via sox, could configured in settings.conf)
- speech driver: speechd
- braille driver: brltty (WIP)