From df6e9a2ec69d72ba4381adfe59c844e2498ea236 Mon Sep 17 00:00:00 2001 From: Atubulated <149507574+Atubulated@users.noreply.github.com> Date: Fri, 19 Sep 2025 12:21:59 +0100 Subject: [PATCH] docs: expand installation section with detailed steps (fixes #84) Added clear setup instructions, PyTorch guidance, env vars, and troubleshooting. --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 70dec26..9ff3e06 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,19 @@ OpenDeepSearch is a lightweight yet powerful search tool designed for seamless i - [Description 📝](#description-) - [Table of Contents 📑](#table-of-contents-) - [Features ✨](#features-) - - [Installation 📚](#installation-) + - ## Installation (Beginner-Friendly) + +### Prerequisites +- *Python*: 3.10–3.12 recommended (some dependencies may not install on newer versions yet). +- *Git* +- *Optional*: NVIDIA GPU + CUDA drivers if you want GPU acceleration. + +### 1. Create and activate a virtual environment +*Linux / macOS* +```bash +python3 -m venv .venv +source .venv/bin/activate +python -m pip install --upgrade pip setuptools wheel - [Setup](#setup) - [Usage ️](#usage-️) - [Using OpenDeepSearch Standalone 🔍](#using-opendeepsearch-standalone-)