GarbageReminder/Docs
GarbageReminder/Docs
1
0
Fork 0
Code Issues Pull Requests Actions Releases Wiki Activity

Repo readme improved

Browse Source
This commit is contained in:
Profitroll 2024-05-13 23:41:17 +02:00
parent 5bf63964fd
commit 5102d24640
Signed by: profitroll
GPG Key ID: FA35CAB49DACD3B2
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,3 +1,18 @@
# Garbage Reminder Documentation
This documentation is under development and is not finished yet.
Documentation made with MkDocs Material for API, bots and contributions.
## Requirements
* Git
* Python 3.8+ (tested on 3.9 to 3.11)
## Building the docs
1. Clone the repo using `git clone https://git.end-play.xyz/GarbageReminder/Docs.git`
2. Go to the `Docs` directory
3. Create a virtual environment using `python -m venv .venv`
4. Activate it using `.venv/bin/activate` or `.venv\Scripts\activate.bat`
5. Install the dependencies using `pip install -r requirements.txt`
6. Build the docs using `mkdocs build`
7. Deploy as any other file-based website. The generated website is under `site`