Update README.md

README.md

@@ -7,23 +7,25 @@ This is the code repository for the DEval project "Durchführung und Unterstütz
 
 - **[Get Started](#get-started)**
 
-  - [Setting-up the environment](#setting-up-the-environment)
-  - [Load EPD Data](#load-epd-data)
-  - [PostGres](#postgres)
-
-- [Contribute](#contribute)
-  - [Unit Tests](#unit-tests)
-  - [Deploy to Heroku](#deploy-to-heroku)
-- [Support](#support)
-- [License](#license)
+  - [Set up `.env` file](#set-up-env-file)
+  - [Set up the environment](#set-up-the-environment)
+  - [Run the code](#run-the-code)
 
 ---
 
 ## Get started
 
-To run, the project expects secret keys from a `.env` file.
+### Set up `.env` file
+To run, the project expects secret keys from a `.env` file. Due to security reasons, this file should not be committed to version control!
+
+Here how the `.env` file should look like:
 
-### Setting-up the environment
+```
+# OPENAI_API_KEY
+OPENAI_API_KEY= # Your OpenAI API key
+```
+
+### Set up the environment
 We use `uv` as a python and our package dependency manager. Follow these [instructions](https://docs.astral.sh/uv/getting-started/installation/) to install with the standalone installer and `curl`
 
 Next, to set up the local dependencies. You can find further information [here](https://docs.astral.sh/uv/guides/projects/#managing-dependencies)
@@ -31,16 +33,19 @@ Next, to set up the local dependencies. You can find further information [here](
 uv sync
 ```
 
-This should give you a package structure like this with a `.venv` file
+This should give you a package structure like this with a `.venv` directory:
 ```
 .
 ├── .venv
 ├── .python-version
+├── app.py
+├── pyproject.toml
 ├── README.md
-├── main.py
-└── pyproject.toml
+└── uv.lock
 ```
 
+#### uv.lock
+`uv.lock` is a cross-platform lockfile that contains exact information about the project's dependencies. Unlike the `pyproject.toml` which is used to specify the broad requirements of the project, the lockfile contains the exact resolved versions that are installed in the project environment via `uv`. This file should be checked into version control, allowing for consistent and reproducible installations across machines. `uv.lock` is a human-readable TOML file but is managed by `uv` and should NOT be edited manually.
 
 Alternatively, with a different dependency manager such as `venv` install directly from `pyproject.toml`.
 ```Bash
@@ -49,10 +54,12 @@ Alternatively, with a different dependency manager such as `venv` install direct
 **Note**: the dependencies then need to be documented manually in the `pyproject.toml`.
 
 
+### Run the code
 
-## To-Do
- - create bsaic set-up with Qdrant in memory, ingestion pipeline
- - create basic set-up where retrieval is not yet having an llm call
- - connect to frontend with "invoke" and deletion of memory
+After installing the needed dependencies for the project and setting up the environment, execute the code from the root of the repository by running the `app.py` script via `uv` with the following command:
 
+```Bash
+uv run app.py
+```
 
+You will see the logging in the terminal and receive a link to access the currently locally hosted Gradio User Interface.