From 98a9c766ef2daf89d373a519ff2388215ca0e5de Mon Sep 17 00:00:00 2001
From: Ritish Srivastava <121374890+Ritish134@users.noreply.github.com>
Date: Wed, 18 Oct 2023 07:49:24 +0530
Subject: [PATCH] Update README.md
Enhance grammar and formatting in various sections.
---
README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index c24a7483e..4ff317d09 100644
--- a/README.md
+++ b/README.md
@@ -55,7 +55,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
## Useful links
- - 🔍🔥 [Live preview](https://docsgpt.arc53.com/)
+ - 🔍🔥 [Live Preview](https://docsgpt.arc53.com/)
- 💬🎉[Join our Discord](https://discord.gg/n5BX8dh8rU)
@@ -131,7 +131,7 @@ Make sure you have Python 3.10 or 3.11 installed.
(check out [`application/core/settings.py`](application/core/settings.py) if you want to see more config options.)
2. (optional) Create a Python virtual environment:
-You can follow the [Python official documentation](https://docs.python.org/3/tutorial/venv.html) for virtual environments.
+You can refer to the [official Python documentation](https://docs.python.org/3/tutorial/venv.html) for virtual environments.
a) On Mac OS and Linux
```commandline
@@ -156,7 +156,7 @@ pip install -r requirements.txt
Make sure you have Node version 16 or higher.
1. Navigate to the [/frontend](https://github.com/arc53/DocsGPT/tree/main/frontend) folder.
-2. Install required packages `husky` and `vite` (ignore if installed).
+2. Install the required packages `husky` and `vite` (ignore if already installed).
```commandline
npm install husky -g
npm install vite -g
@@ -173,8 +173,8 @@ We as members, contributors, and leaders, pledge to make participation in our co
## Many Thanks To Our Contributors
-
- 
+
+
## License