gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: align README with OpenRAG documentation

Browse source
This commit is contained in:
Vishal 2026-01-12 22:47:35 +05:30
parent 11b90f20bb
commit adcd41eb8a
1 changed files with 7 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -26,47 +26,22 @@ OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables
## Quickstart ## Quickstart
To run OpenRAG without creating or modifying any project files, use `uvx`: The recommended way to get started with OpenRAG is through the official documentation quickstart guide, which contains up-to-date installation steps, prerequisites, and usage examples:
```bash 👉 https://docs.openr.ag/quickstart
uvx openrag
```
This command runs OpenRAG without installing it to your project or globally. The GitHub repository focuses on the source code. Please refer to the documentation for setup and usage instructions.
To run a specific version of OpenRAG, run `uvx --from openrag==VERSION openrag`.
## Install Python package ## Install Python package
To add the OpenRAG Python package to a Python project, use `uv`: OpenRAG can be installed as a Python package. For detailed installation steps, environment requirements, and environment setup guidance (e.g., managing virtual environments), see the official documentation:
1. Create a new project with a virtual environment using `uv init`: 👉 https://docs.openr.ag/install
👉 https://docs.astral.sh/uv/pip/environments
```bash This ensures you are following the most current and supported setup.
uv init YOUR_PROJECT_NAME
cd YOUR_PROJECT_NAME
```
The `(venv)` prompt doesn't change, but `uv` commands will automatically use the project's virtual environment.
For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments).
2. Add OpenRAG to your project:
```bash
uv add openrag
```
To add a specific version of OpenRAG, run `uv add openrag==VERSION`.
3. Start the OpenRAG terminal user interface (TUI):
```bash
uv run openrag
```
4. Continue with the [Quickstart](https://docs.openr.ag/quickstart).
For all installation options, see the [OpenRAG installation guide](https://docs.openr.ag/install).
## Docker or Podman installation ## Docker or Podman installation