mirror of
https://github.com/SamueleLorefice/isleBot.git
synced 2026-01-15 06:03:42 +00:00
Updated gitignore and readme
This commit is contained in:
18
Readme.md
18
Readme.md
@@ -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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user