added installation section to README

README.md

@@ -22,6 +22,7 @@ WKLP is a simple Question Answering system, based on data crawled from [Twin Pea
 
   - [Project architecture 🧱](#project-architecture-)
   - [What can I learn from this project? 📚](#what-can-i-learn-from-this-project-)
+  - [Installation 💻](#installation-)
   - [Repository structure 📁](#repository-structure-)
   - [Possible improvements ✨](#possible-improvements-)
 ---
@@ -54,6 +55,14 @@ WKLP is a simple Question Answering system, based on data crawled from [Twin Pea
 
 Within each folder, you can find more in-depth explanations.
 
+## Installation 💻
+To install this project locally, follow these steps:
+- `git clone https://github.com/anakin87/who-killed-laura-palmer`
+- `cd who-killed-laura-palmer`
+- `pip install -r requirements.txt`
+
+To run the web app, simply type: `streamlit run app.py`
+
 ## Possible improvements ✨
 ### Project structure
 - The project is optimized to be deployed in Hugging Face Spaces and consists of an all-in-one Streamlit web app. In more structured production environments, I suggest dividing the software into three parts:

crawler/README.md

@@ -5,8 +5,8 @@ This crawler download texts and metadata from [Twin Peaks Fandom Wiki](https://t
 *Several wiki pages are discarded, since they are not related to Twin Peaks plot and create noise in the Question Answering index.*
 
 ## Installation
-- `pip install -r requirements.txt`
 - copy this folder (if needed, see [stackoverflow](https://stackoverflow.com/questions/7106012/download-a-single-folder-or-directory-from-a-github-repo))
+- `pip install -r requirements.txt`
 
 ## Usage
 - (if needed, activate the virtual environment)

requirements.dev.txt

@@ -1,5 +0,0 @@
-farm-haystack[faiss]==1.4.0
-markdown
-st-annotated-text
-streamlit==1.2.0
-protobuf==3.20.1