Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
phoenixpereira committed May 17, 2024
1 parent 8d206aa commit fdf44a9
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .example.env
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
GUILD_ID=GUILD_ID
BOT_TOKEN="BOT_TOKEN"
BOT_TOKEN="BOT_TOKEN"
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,41 @@
# 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

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

Expand Down

0 comments on commit fdf44a9

Please sign in to comment.