From 621129f500c4d9022f3b54eaad5583f421dc9949 Mon Sep 17 00:00:00 2001 From: Zeng haolong <68734681+Mitchell-xiyunfeng@users.noreply.github.com> Date: Tue, 2 Dec 2025 22:14:50 +0800 Subject: [PATCH] Optimize README.md 1. Add a Chinese version of the deepwiki-like code repository interpretation agent called zread. This will be more user-friendly for the Chinese community. 2. Optimize README.md. --- README.md | 66 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 827b000a4..68f9c666f 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,15 @@ license - - Ask DeepWiki -

+
+ +[![DeepWiki](https://img.shields.io/badge/Ask%20DeepWiki-0052D9.svg?labelColor=000000&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/infiniflow/ragflow)    +[![Zread](https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=0052D9&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff)](https://zread.ai/infiniflow/ragflow) + +
+

Document | Roadmap | @@ -61,8 +65,8 @@ - 🔎 [System Architecture](#-system-architecture) - 🎬 [Get Started](#-get-started) - 🔧 [Configurations](#-configurations) -- 🔧 [Build a Docker image](#-build-a-docker-image) -- 🔨 [Launch service from source for development](#-launch-service-from-source-for-development) +- 🔧 [Build a Docker Image](#-build-a-docker-image) +- 🔨 [Launch Service from Source for Development](#-launch-service-from-source-for-development) - 📚 [Documentation](#-documentation) - 📜 [Roadmap](#-roadmap) - 🏄 [Community](#-community) @@ -72,7 +76,7 @@ ## 💡 What is RAGFlow? -[RAGFlow](https://ragflow.io/) is a leading open-source Retrieval-Augmented Generation (RAG) engine that fuses cutting-edge RAG with Agent capabilities to create a superior context layer for LLMs. It offers a streamlined RAG workflow adaptable to enterprises of any scale. Powered by a converged context engine and pre-built agent templates, RAGFlow enables developers to transform complex data into high-fidelity, production-ready AI systems with exceptional efficiency and precision. +[RAGFlow](https://ragflow.io/) is a leading open-source Retrieval-Augmented Generation (RAG) engine that combines cutting-edge RAG techniques with Agent capabilities to create a superior context layer for Large Language Models (LLMs). It offers a streamlined RAG workflow adaptable to enterprises of any scale. Powered by a converged context engine and pre-built agent templates, RAGFlow enables developers to transform complex data into high-fidelity, production-ready AI systems with exceptional efficiency and precision. ## 🎮 Demo @@ -85,8 +89,8 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). ## 🔥 Latest Updates -- 2025-11-19 Supports Gemini 3 Pro. -- 2025-11-12 Supports data synchronization from Confluence, S3, Notion, Discord, Google Drive. +- 2025-11-19 Supports Google's latest Gemini 3 Pro. +- 2025-11-12 Supports data synchronization from Confluence, S3, Notion, Discord, and Google Drive. - 2025-10-23 Supports MinerU & Docling as document parsing methods. - 2025-10-15 Supports orchestrable ingestion pipeline. - 2025-08-08 Supports OpenAI's latest GPT-5 series models. @@ -97,8 +101,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). ## 🎉 Stay Tuned -⭐️ Star our repository to stay up-to-date with exciting new features and improvements! Get instant notifications for new -releases! 🌟 +🌟 Star our repository to stay up-to-date with exciting new features and improvements, and receive instant notifications for new releases! 🌟
@@ -115,9 +118,9 @@ releases! 🌟 ### 🍱 **Template-based chunking** - Intelligent and explainable. -- Plenty of template options to choose from. +- A variety of template options are available for you to choose from. -### 🌱 **Grounded citations with reduced hallucinations** +### 🌱 **Grounded citations reduce hallucinations** - Visualization of text chunking to allow human intervention. - Quick view of the key references and traceable citations to support grounded answers. @@ -129,7 +132,7 @@ releases! 🌟 ### 🛀 **Automated and effortless RAG workflow** - Streamlined RAG orchestration catered to both personal and large businesses. -- Configurable LLMs as well as embedding models. +- Configurable LLMs as well as Embedding models. - Multiple recall paired with fused re-ranking. - Intuitive APIs for seamless integration with business. @@ -143,14 +146,14 @@ releases! 🌟 ### 📝 Prerequisites -- CPU >= 4 cores +- CPU >= 4 Cores - RAM >= 16 GB - Disk >= 50 GB -- Docker >= 24.0.0 & Docker Compose >= v2.26.1 +- Docker >= v24.0.0 & Docker Compose >= v2.26.1 - [gVisor](https://gvisor.dev/docs/user_guide/install/): Required only if you intend to use the code executor (sandbox) feature of RAGFlow. > [!TIP] -> If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/). +> If you have not installed Docker on your local machine (Windows, Mac, or Linux), please see [Install Docker Engine](https://docs.docker.com/engine/install/). ### 🚀 Start up the server @@ -185,7 +188,7 @@ releases! 🌟 > [!CAUTION] > All Docker images are built for x86 platforms. We don't currently offer Docker images for ARM64. -> If you are on an ARM64 platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a Docker image compatible with your system. +> If you are on an ARM64 platform, please follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a Docker image compatible with your system. > The command below downloads the `v0.22.1` edition of the RAGFlow Docker image. See the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from `v0.22.1`, update the `RAGFLOW_IMAGE` variable accordingly in **docker/.env** before using `docker compose` to start the server. @@ -204,14 +207,14 @@ releases! 🌟 # docker compose -f docker-compose.yml up -d ``` -> Note: Prior to `v0.22.0`, we provided both images with embedding models and slim images without embedding models. Details as follows: +> Note: Prior to version `v0.22.0`, we offered both images with embedding models and slim images without embedding models. The details are as follows: | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? | | ----------------- | --------------- | --------------------- | ------------------------ | | v0.21.1 | ≈9 | ✔️ | Stable release | | v0.21.1-slim | ≈2 | ❌ | Stable release | -> Starting with `v0.22.0`, we ship only the slim edition and no longer append the **-slim** suffix to the image tag. +> Beginning with version `v0.22.0`, we now ship only the slim edition and have discontinued appending the **-slim** suffix to the image tag. 4. Check the server status after having the server up and running: @@ -271,7 +274,7 @@ Updates to the above configurations require a reboot of all containers to take e ### Switch doc engine from Elasticsearch to Infinity -RAGFlow uses Elasticsearch by default for storing full text and vectors. To switch to [Infinity](https://github.com/infiniflow/infinity/), follow these steps: +RAGFlow uses **Elasticsearch** by default for storing full text and vectors. To switch to [Infinity](https://github.com/infiniflow/infinity/), follow these steps: 1. Stop all running containers: @@ -292,9 +295,9 @@ RAGFlow uses Elasticsearch by default for storing full text and vectors. To swit > [!WARNING] > Switching to Infinity on a Linux/arm64 machine is not yet officially supported. -## 🔧 Build a Docker image +## 🔧 Build a Docker Image -This image is approximately 2 GB in size and relies on external LLM and embedding services. +This docker image is approximately 2 GB in size and relies on external LLM and Embedding services. ```bash git clone https://github.com/infiniflow/ragflow.git @@ -302,7 +305,7 @@ cd ragflow/ docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly . ``` -## 🔨 Launch service from source for development +## 🔨 Launch Service from Source for Development 1. Install `uv` and `pre-commit`, or skip this step if they are already installed: @@ -314,7 +317,7 @@ docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly ```bash git clone https://github.com/infiniflow/ragflow.git cd ragflow/ - uv sync --python 3.10 # install RAGFlow dependent python modules + uv sync --python 3.10 # install RAGFlow dependent python modules uv run download_deps.py pre-commit install ``` @@ -329,7 +332,7 @@ docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly ``` 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager ``` -4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site: +4. If you cannot access HuggingFace, please set the `HF_ENDPOINT` environment variable to use a mirror site: ```bash export HF_ENDPOINT=https://hf-mirror.com @@ -365,7 +368,7 @@ docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly npm run dev ``` - _The following output confirms a successful launch of the system:_ + 🎉 _The following output confirms a successful launch of the system:_ 🎉 ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) 9. Stop RAGFlow front-end and back-end service after development is complete: @@ -378,15 +381,15 @@ docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly - [Quickstart](https://ragflow.io/docs/dev/) - [Configuration](https://ragflow.io/docs/dev/configurations) -- [Release notes](https://ragflow.io/docs/dev/release_notes) -- [User guides](https://ragflow.io/docs/dev/category/guides) -- [Developer guides](https://ragflow.io/docs/dev/category/developers) +- [Release Notes](https://ragflow.io/docs/dev/release_notes) +- [User Guides](https://ragflow.io/docs/dev/category/guides) +- [Developer Guides](https://ragflow.io/docs/dev/category/developers) - [References](https://ragflow.io/docs/dev/category/references) - [FAQs](https://ragflow.io/docs/dev/faq) ## 📜 Roadmap -See the [RAGFlow Roadmap 2025](https://github.com/infiniflow/ragflow/issues/4214) +Please see the [RAGFlow Roadmap 2025](https://github.com/infiniflow/ragflow/issues/4214) ## 🏄 Community @@ -396,5 +399,4 @@ See the [RAGFlow Roadmap 2025](https://github.com/infiniflow/ragflow/issues/4214 ## 🙌 Contributing -RAGFlow flourishes via open-source collaboration. In this spirit, we embrace diverse contributions from the community. -If you would like to be a part, review our [Contribution Guidelines](https://ragflow.io/docs/dev/contributing) first. +RAGFlow flourishes via open-source collaboration, and in this spirit, we welcome diverse contributions from the community. If you would like to be a part, please review our [Contribution Guidelines](https://ragflow.io/docs/dev/contributing) first.