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

remove outdated TOC, expand develop and trbsh

Browse source
This commit is contained in:
April M 2026-01-13 06:21:43 -08:00
parent adcd41eb8a
commit fc299f78af
1 changed files with 9 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -15,43 +15,20 @@ OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables
<a href="https://deepwiki.com/langflow-ai/openrag"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a> <a href="https://deepwiki.com/langflow-ai/openrag"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
</div> ## Install OpenRAG
<div align="center">
<a href="#quickstart" style="color: #0366d6;">Quickstart</a> &nbsp;&nbsp;|&nbsp;&nbsp;
<a href="#install-python-package" style="color: #0366d6;">Python package</a> &nbsp;&nbsp;|&nbsp;&nbsp;
<a href="#docker-or-podman-installation" style="color: #0366d6;">Docker or Podman</a> &nbsp;&nbsp;|&nbsp;&nbsp;
<a href="#development" style="color: #0366d6;">Development</a> &nbsp;&nbsp;|&nbsp;&nbsp;
<a href="#troubleshooting" style="color: #0366d6;">Troubleshooting</a>
</div>
## Quickstart To get started with OpenRAG, see the installation guides in the OpenRAG documentation:
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: * [Quickstart](https://docs.openr.ag/quickstart)
* [Install the OpenRAG Python package](https://docs.openr.ag/install-options)
👉 https://docs.openr.ag/quickstart * [Deploy self-managed services with Docker or Podman](https://docs.openr.ag/docker)
The GitHub repository focuses on the source code. Please refer to the documentation for setup and usage instructions.
## Install Python package
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:
👉 https://docs.openr.ag/install
👉 https://docs.astral.sh/uv/pip/environments
This ensures you are following the most current and supported setup.
## Docker or Podman installation
By default, OpenRAG automatically starts the required containers and helps you manage them.
To install OpenRAG with self-managed containers, see the [OpenRAG installation guide](https://docs.openr.ag/docker).
## Development ## Development
For developers wanting to contribute to OpenRAG or set up a development environment, see [CONTRIBUTING.md](CONTRIBUTING.md). For developers who want to [contribute to OpenRAG](https://docs.openr.ag/support/contribute) or set up a development environment, see [CONTRIBUTING.md](CONTRIBUTING.md).
## Troubleshooting ## Troubleshooting
For common issues and fixes, see [Troubleshoot OpenRAG](https://docs.openr.ag/support/troubleshoot). For assistance with OpenRAG, see [Troubleshoot OpenRAG](https://docs.openr.ag/support/troubleshoot) and visit the [Discussions page](https://github.com/langflow-ai/openrag/discussions).
To report a bug or submit a feature request, visit the [Issues page](https://github.com/langflow-ai/openrag/issues).