diff --git a/README b/README index ab7cf39b1cb26dba650337eaa29b44732a7bb098..bc0de12b966c7569610f97979c2145126cd8b392 100644 --- a/README +++ b/README @@ -1,27 +1,37 @@ -Deps: +Deps +---- -- gtk3 for python2 (package is python2-gobject in archlinux, as well as gtk3) +- gtk3 for python2 (package is python2-gobject in archlinux) - liblo with python2 bindings (OSC library) -- get and compile https://github.com/alumae/gst-kaldi-nnet2-online (which requires kaldi) -Install: +Install +------- -./download-models.sh +1) ./download-models.sh -copy libgstkaldionline2.so to ./asr/ or change GST_PLUGIN_PATH in main.py to point to its directory +2) get and build gst plugin from https://gitlab.lif.univ-mrs.fr/benoit.favre/gst-kaldi-nnet2-online-rocio -Run: +3) copy libgstkaldionline2.so to ./asr/ or change GST_PLUGIN_PATH in main.py to point to its directory -- The main program: +4) go to slu/src and build the slu library with make (requires openfst) + +Run +--- + +1) The main program: ./start.sh -- The osc server: +2) The osc server (optional): python2 osc.py -Doc: +Documentation +------------- + +Some doc for gtk development: developing with pygtk3: http://lazka.github.io/pgi-docs/, https://python-gtk-3-tutorial.readthedocs.org/en/latest/ -Todo: +Todo +---- DONE configuration for osc DONE non intrusive animated scrolling