updated readme

This commit is contained in:
Samuele Lorefice
2023-11-05 17:26:58 +01:00
parent bedf84a73a
commit 0685bc33ce
2 changed files with 10 additions and 4 deletions

6
.idea/dbnavigator.xml generated
View File

@@ -1,5 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="DBNavigator.Project.DatabaseBrowserManager">
<autoscroll-to-editor value="false" />
<autoscroll-from-editor value="true" />
<show-object-properties value="true" />
<loaded-nodes />
</component>
<component name="DBNavigator.Project.DatabaseFileManager">
<open-files />
</component>

View File

@@ -8,15 +8,15 @@
#### Setup
1. Clone the repo
2. create a venv `python -m venv venv` and activate it `venv\Scripts\activate.bat` or the ps1 variant for powershell
3. install requirements with `pip install -r requirements.txt`
4. create a `.env` file with the following contents:
2. Create a venv by running `python -m venv venv` and activate it using `venv\Scripts\activate.bat` or the ps1 variant for powershell
3. Install requirements with `pip install -r requirements.txt`
4. Create a `.env` file with the following contents:
```ini
TOKEN=your_discord_bot_token_here
```
5. Run `start.ps1` or `start.bat`
6. Invite the bot to your server
7. profit!
7. Profit!
##### Notes
The bot is provided as is and is not guaranteed to work. If you have any issues, please open an issue on the github repo. I might or might not fix it.