From 4c85ee2bb197429350e645a88aa5c271117a8603 Mon Sep 17 00:00:00 2001 From: Alex Date: Fri, 3 Feb 2023 14:49:02 +0000 Subject: [PATCH 1/3] Update README.md --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 09e42090..91a5c94f 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,17 @@ The aim of DocsGPT is to utilize the GPT engine to answer questions about the documentation of any project, making it easier for developers to find the information they need . ## Project structure +application - flask app (main application) +extensions - chrome extension +scripts - script that creates similarity search index and store for other libraries + + +## Join our community here [Discord](https://discord.gg/guzNA6DSBk) + +## [Guides](https://github.com/arc53/docsgpt/wiki) -## [Discord](https://discord.gg/guzNA6DSBk) +## [How to use any other documentation](https://github.com/arc53/docsgpt/wiki/How-to-train-on-other-documentation) -Join our community here [Discord](https://discord.gg/guzNA6DSBk) - -## Guides - -## How to use any other documentation +Built with [🦜️🔗 LangChain](https://github.com/hwchase17/langchain) From b9dbd33fdc8c986c8f6651119838029919dcc510 Mon Sep 17 00:00:00 2001 From: Alex Date: Fri, 3 Feb 2023 14:49:28 +0000 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 91a5c94f..15a30941 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ The aim of DocsGPT is to utilize the GPT engine to answer questions about the do ## Project structure application - flask app (main application) + extensions - chrome extension + scripts - script that creates similarity search index and store for other libraries From b35bab7909795222ca805f1e060bf831772d9467 Mon Sep 17 00:00:00 2001 From: Alex Date: Fri, 3 Feb 2023 14:52:22 +0000 Subject: [PATCH 3/3] Update README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 15a30941..dcd15674 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,16 @@ extensions - chrome extension scripts - script that creates similarity search index and store for other libraries +## QuickStart +Please note: current vector database uses pandas Python documentation, thus responses will be related to it, if you want to use other docs please follow a guide below +1. Navigate to `/application` folder +2. Install dependencies +`pip install -r requirements.txt` +3. Prepare .env file +Copy .env_sample and create .env with your openai api token +4. Run the app +`python app.py` ## Join our community here [Discord](https://discord.gg/guzNA6DSBk) ## [Guides](https://github.com/arc53/docsgpt/wiki)