Skip to content

Commit

Permalink
updated Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Harshal6927 committed Jul 30, 2024
1 parent 944f948 commit 8819070
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,19 @@

Create a discord application and get token from the [Discord Developer Portal](https://discord.com/developers/applications) and add it to the `.env` file. Refer to the `.env.example` file for the format.

### Database

We are using [pickle](https://docs.python.org/3/library/pickle.html) to store the data. The database file is `data/database.pkl`. You can delete this file to reset the database.

### Virutal Environment

Clone this repo and open the folder, then run the below to commands in the terminal to create a virtual environment.

```bash
#windows
# windows
py -m venv venv

#linux
# linux
python3 -m venv venv
```

Expand All @@ -41,3 +45,20 @@ py main.py
# Linux
python3 main.py
```

### Development

If you added any new slash commands or updated the existing ones, you need to sync the commands with the discord server. To sync the commands, first add your discord user id in `cogs/admin.py` file and run the following command in the discord server.

Note: you have to start the bot before running this command

```bash
!sync
```

### Authors

- [Harshal](https://github.com/Harshal6927)
- [David](https://github.com/DavidLlanio)
- [MM](https://github.com/mm-xo)
- [Brody](https://github.com/brodycritchlow)

0 comments on commit 8819070

Please sign in to comment.