From fdf44a9cd53df567861ce3d1f3d44e98f44b24e2 Mon Sep 17 00:00:00 2001 From: Phoenix Isaac Pereira Date: Fri, 17 May 2024 16:37:05 +0930 Subject: [PATCH] docs: Update README --- .example.env | 2 +- README.md | 31 ++++++++++++++++++------------- 2 files changed, 19 insertions(+), 14 deletions(-) diff --git a/.example.env b/.example.env index 00d2b11..1bb16e8 100644 --- a/.example.env +++ b/.example.env @@ -1,2 +1,2 @@ GUILD_ID=GUILD_ID -BOT_TOKEN="BOT_TOKEN" \ No newline at end of file +BOT_TOKEN="BOT_TOKEN" diff --git a/README.md b/README.md index f07a9c1..8115aa8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # DuckBot -DuckBot is a Discord bot written in Python using the discord.py library for the CS Club's Discord Server. It provides various commands and functionalities to enhance your Discord server experience. +DuckBot is a Discord bot written in Python using the discord.py library for the CS Club's Discord Server. It provides various commands and functionality to enhance your Discord server experience. ## Getting Started @@ -8,29 +8,34 @@ To get started, please follow these steps: 1. Install Poetry if not already installed: -```bash -curl -sSL https://install.python-poetry.org | python3 - -``` + Linux, macOS, Windows (WSL) + ```bash + curl -sSL https://install.python-poetry.org | python3 - + ``` + Windows (Powershell) + ```bash + (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py - + ``` 2. Install the dependencies. -```bash -poetry install -``` + ```bash + poetry install + ``` 3. Copy `.env.example` to a new file `.env` and set required environment variables. 4. Navigate to the src directory -```bash -cd src -``` + ```bash + cd src + ``` 5. Run the bot. -```bash -poetry run python main.py -``` + ```bash + poetry run python main.py + ``` ## Contributing