From fcdde9fbe0cd87346377d39742bcdcb24b5f2f76 Mon Sep 17 00:00:00 2001
From: Romain Quinet <r.quinet@evs.com>
Date: Fri, 6 Oct 2023 21:47:59 +0200
Subject: [PATCH] Added README.MD

---
 README.MD | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.MD

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..387b683
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,25 @@
+# Darknet Diaries LLM
+## How to run
+### Install dependencies
+I have no idea what the correct way to install dependencies with python is. Somehow install these libraries and their dependencies:
+- llama_index
+- beautifulsoup4
+### Execution
+Download transcripts:
+```shell
+python3 download_transcripts.py
+```
+
+Set OpenAPI key as environment variable
+```shell
+OPEN_API_KEY=<your key>
+```
+
+Then run the main file
+```shell
+python3 main.py
+```
+
+On the first run, it will generate the index. This can take a while, but it will be cached on disk for the next runs.
+
+You can them ask it any questions about Darknet Diaries!
\ No newline at end of file