docs: update project documentation

- Updated project documentation to include the latest information, changes, and improvements for better clarity and understanding.
This commit is contained in:
Rajtilak Bhattacharjee 2023-11-15 19:56:25 +05:30
parent b171afc496
commit 753a014e40
2 changed files with 6 additions and 7 deletions

View File

@ -2,19 +2,19 @@
## Using the GitHub repository
1. Clone the GitHub repository:\
1. Clone the GitHub repository:
`git clone https://github.com/rajtilakjee/keepyourmouthshut.git`
2. Create a virtual environment using `venv`\
2. Create a virtual environment using `venv`
`python -m venv .venv`
3. Activate the virtual environment\
3. Activate the virtual environment
`.venv\Script\activate`
4. Install the dependencies\
4. Install the dependencies
`pip install -r requirements.txt`
5. Run the app\
5. Run the app
`streamlit run src/main.py`
## Using the Docker image
1. Pull the Docker image\
1. Pull the Docker image
`docker pull rajtilakjee/keepyourmouthshut:1.0.0`
2. Start using the image

View File

@ -57,6 +57,5 @@ copyright: >-
nav:
- Home: index.md
- Usage: usage.md
- Development: development.md
- Resources: resources.md
- Acknowledgement: acknowledgement.md