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:
parent
b171afc496
commit
753a014e40
|
@ -2,19 +2,19 @@
|
||||||
|
|
||||||
## Using the GitHub repository
|
## Using the GitHub repository
|
||||||
|
|
||||||
1. Clone the GitHub repository:\
|
1. Clone the GitHub repository:
|
||||||
`git clone https://github.com/rajtilakjee/keepyourmouthshut.git`
|
`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`
|
`python -m venv .venv`
|
||||||
3. Activate the virtual environment\
|
3. Activate the virtual environment
|
||||||
`.venv\Script\activate`
|
`.venv\Script\activate`
|
||||||
4. Install the dependencies\
|
4. Install the dependencies
|
||||||
`pip install -r requirements.txt`
|
`pip install -r requirements.txt`
|
||||||
5. Run the app\
|
5. Run the app
|
||||||
`streamlit run src/main.py`
|
`streamlit run src/main.py`
|
||||||
|
|
||||||
## Using the Docker image
|
## Using the Docker image
|
||||||
|
|
||||||
1. Pull the Docker image\
|
1. Pull the Docker image
|
||||||
`docker pull rajtilakjee/keepyourmouthshut:1.0.0`
|
`docker pull rajtilakjee/keepyourmouthshut:1.0.0`
|
||||||
2. Start using the image
|
2. Start using the image
|
||||||
|
|
|
@ -57,6 +57,5 @@ copyright: >-
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Usage: usage.md
|
- Usage: usage.md
|
||||||
- Development: development.md
|
|
||||||
- Resources: resources.md
|
- Resources: resources.md
|
||||||
- Acknowledgement: acknowledgement.md
|
- Acknowledgement: acknowledgement.md
|
||||||
|
|
Loading…
Reference in New Issue