From 6b4dfa13b6cd26084333856ba3449ffdecb24087 Mon Sep 17 00:00:00 2001 From: Ruben Lucas Date: Thu, 17 Apr 2025 13:47:36 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20separate=20project=20env?= =?UTF-8?q?=20setup=20section?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c94f3fa..9980400 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ A generic Retrieval Augmented Generation (RAG) demo from Sogeti Netherlands buil - [Table of Contents](#table-of-contents) - [Features](#features) - [Getting started](#getting-started) + - [Project Environment Setup](#project-environment-setup) - [Installation of system dependencies](#installation-of-system-dependencies) - [Unstructered PDF loader (optional)](#unstructered-pdf-loader-optional) - [Local LLM (optional)](#local-llm-optional) @@ -25,7 +26,7 @@ A generic Retrieval Augmented Generation (RAG) demo from Sogeti Netherlands buil ## Getting started -### Installation of system dependencies +### Project Environment Setup This project leverages a modern packaging method defined in `pyproject.toml`. After cloning the repository, you can install the project along with its dependencies. You have two options: 1. Using uv @@ -44,6 +45,10 @@ source .venv/bin/activate # Activate the virtual environment (use ".venv\Scrip pip install . # Install the project and its dependencies ``` +### Installation of system dependencies + +Some optional features require additional system applications to be installed. + #### Unstructered PDF loader (optional) If you would like to run the application using the unstructered PDF loader (`pdf.unstructured` setting) you need to install two system dependencies.