From a1161026c2daf9ff5a15557b04394b219d034d69 Mon Sep 17 00:00:00 2001 From: ian Date: Thu, 25 Apr 2024 17:15:34 +0700 Subject: [PATCH] update --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8c11bcd3a..78db80e19 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # kotaemon +Build and use local RAG-based Question Answering (QA) applications. + https://github.com/Cinnamon/kotaemon/assets/25688648/815ecf68-3a02-4914-a0dd-3f8ec7e75cd9 [Source Code](https://github.com/Cinnamon/kotaemon) | @@ -13,9 +15,7 @@ https://github.com/Cinnamon/kotaemon/assets/25688648/815ecf68-3a02-4914-a0dd-3f8 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![built with Codeium](https://codeium.com/badges/main)](https://codeium.com) -Build and use local RAG-based Question Answering (QA) applications. - -This repository would like to appeal to both end users who want to do QA on their +This project would like to appeal to both end users who want to do QA on their documents and developers who want to build their own QA pipeline. - For end users: @@ -34,6 +34,13 @@ open source. ## Installation +### For end users + +This document is intended for developers. If you just want to install and use the app as +it, please follow the [User Guide](https://cinnamon.github.io/kotaemon/). + +### For developers + ```shell # Create a environment python -m venv kotaemon-env