diff --git a/README.md b/README.md index 61ccb407..85b0f9b3 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,26 @@ An TTY screenreader for Linux. Be careful, is just experimental now. # requirements -linux -python3 -python-espeak -python-evdev -loaded uinput kernelmodule +- linux +- python3 +- python-espeak +- python-evdev +- loaded uinput kernelmodule +Read permission to the following files: +/sys/devices/virtual/tty/tty0/active +/dev/vcsa[1-64] +ReadWrite permission +/dev/input +/dev/uinput # optional -sox [using for soundicons via sox] -speech-dispatcher, python3-speechd [for use the speech-dispatcher] -brltty, python-brlapi [for using braille] # not implemented yet -gstreamer [using for soundicons via gsteramer] # not working yet +- sox [using for soundicons via sox] +- speech-dispatcher, python3-speechd [for use the speech-dispatcher] +- brltty, python-brlapi [for using braille] # not implemented yet +- gstreamer [using for soundicons via gsteramer] # not working yet # installation -ToDO +Currently there is no setupscript (sorry). But you can just run src/fenrir-package/fenrir.py as root or setup the needed permissions + + +