diff --git a/README b/README index bea5d99..75513c1 100644 --- a/README +++ b/README @@ -47,12 +47,24 @@ Description: Speech recognition feedback loops using the first sentence of a sca run: `make ttssr-human-only` Specific Dependencies: -* [pocketsphinx](https://github.com/bambocher/pocketsphinx-python) `sudo pip3 install pocketsphinx` ---> FOLLOW THIS EXAMPLE -* SpeechRecognition 3.8.1 -* PyAudio +* PocketSphinx pacakge `sudo aptitude install pocketsphinx pocketsphinx-en-us` +* Speech Recognition: `sudo pip3 install SpeechRecognition` +* TermColor: `sudo pip3 install termcolor` +* PyAudio: `pip3 install pyaudio` +## Reading the Structure: Joca +Description: Uses OCR'ed text as an input, labels each word for Part-of-Speech, stopwords and sentiment. Then it generates a reading interface +where words with a specific label are hidden. Output can be saved as poster, or exported as json featuring the full data set. +run: `make output/reading_structure/index.html` +Specific Dependencies: +* nltk (http://www.nltk.org/install.html) +* nltk.tokenize.punkt, ne_chunk, pos_tag, word_tokenize, sentiment.vader (https://www.nltk.org/data.html) +* weasyprint (http://weasyprint.readthedocs.io/en/latest/install.html) +* jinja2 (http://jinja.pocoo.org/docs/2.10/intro/#installation) +* font: PT Sans (os font https://www.fontsquirrel.com/fonts/pt-serif) +* font: Ubuntu Mono (os font https://www.fontsquirrel.com/fonts/ubuntu-mono)