From 1fe234914df150269a02583e24076e3e4fc2e77c Mon Sep 17 00:00:00 2001 From: Samuele Lorefice Date: Mon, 6 Nov 2023 20:46:06 +0100 Subject: [PATCH] Updated gitignore and readme --- .gitignore | 5 +++- .idea/.idea.IsleBotSharp/.idea/workspace.xml | 30 ++------------------ Readme.md | 18 ++++++------ 3 files changed, 17 insertions(+), 36 deletions(-) diff --git a/.gitignore b/.gitignore index 7cc029b..9f1b36c 100644 --- a/.gitignore +++ b/.gitignore @@ -394,4 +394,7 @@ FodyWeavers.xsd *.msp # JetBrains Rider -*.sln.iml \ No newline at end of file +*.sln.iml + +# Ignore the config file so you can place the token for your local testing +config.json \ No newline at end of file diff --git a/.idea/.idea.IsleBotSharp/.idea/workspace.xml b/.idea/.idea.IsleBotSharp/.idea/workspace.xml index 6807921..000c6a3 100644 --- a/.idea/.idea.IsleBotSharp/.idea/workspace.xml +++ b/.idea/.idea.IsleBotSharp/.idea/workspace.xml @@ -8,32 +8,8 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - + + diff --git a/Readme.md b/Readme.md index 82e85c3..b161c2d 100644 --- a/Readme.md +++ b/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. +