Updated gitignore and readme

This commit is contained in:
Samuele Lorefice
2023-11-06 20:46:06 +01:00
parent f37998ca9f
commit 1fe234914d
3 changed files with 17 additions and 36 deletions

View File

@@ -8,18 +8,20 @@
#### Setup
1. Clone the repo
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`
2. Run `dotnet restore` in the root directory
3. Open `config.json` and add your discord bot token
4. Run `dotnet build -c Release`
5. Run the resulting build in `bin/Release/net7.0/IsleBot.exe`
6. Invite the bot to your server
7. Profit!
##### Notes
###### FAQ
Q: Why this is now a C# project?
A: I am familiar with C#, and python lacks a decent ORM that isn't a pain to use. Deal with it...
###### 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.
You're welcome to fork the repo and make your own changes, but I do not guarantee that I will be accepting your pull request.
This just a pet project and as such it might get abandoned at any time.