diff --git a/README.md b/README.md index 3eb17b6..baa83d6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # Pushing Scores -## The Pushing Scores project +## The Pushing Scores archival publication +The website was made using Flask, NLTK, Numpy, Pillow and Python3 and is live at http://pushingscores.deplayer.nl/ + +## How to use the scripts + +All of the words on the website have been turned into links. This only needs to be done once, in advance of launching the application. +In order to regenerate the links, you must run these two commands in the following order: + + python3 textedit.py + python3 generate_links.py + +The first script gathers all the files ending in .html, puts them in one single document, and creates wordlist.json, a dictionary that saves the sentences in which every single word appears. The second script goes over the same original files and replaces every word with an appropriate html tag. + +Once these two steps have been made, the application can be run using the following command: + FLASK_APP=contextualise.py flask run + +The generated scores can be found in /var/www/html/pushingscores.deplayer.nl/scores/ + +The project was developed by Cristina Cochior and Julie Boschat Thorez, as part of Varia. diff --git a/requirements.txt b/requirements.txt index 18eebcd..f8a7811 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,8 @@ -Flask~=1.1.1 +Flask==1.0.2 +Jinja2==2.10.1 +MarkupSafe==1.1.1 +nltk==3.4.1 +numpy==1.16.3 +Pillow==6.0.0 +regex==2019.4.14 +tqdm==4.41.1