Skip to content

docs: expand installation section with detailed steps (fixes #84) #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Atubulated wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: expand installation section with detailed steps (fixes #84) #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-)
Expand Down