From d27168a89f050a372845a2582172dc006da3cdf8 Mon Sep 17 00:00:00 2001 From: Macintosh II <95250141+mctaylors@users.noreply.github.com> Date: Wed, 4 Oct 2023 18:18:59 +0300 Subject: [PATCH] Add building & running instructions (#148) Signed-off-by: Macintosh II <95250141+mctaylors@users.noreply.github.com> --- docs/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/README.md b/docs/README.md index 7d899f9..be73f87 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,6 +22,20 @@ Veemo! I'm a general-purpose bot for moderation (formerly known as Boyfriend) wr [//]: # (if you are reading this, message @mctaylors and ask him to bring back the wiki) +## Running Octobot + +1. Install [.NET 7 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) +2. Go to the [Discord Developer Portal](https://discord.com/developers), create a new application and get a bot token. Don't forget to also enable all intents! +3. Clone this repository and open `Octobot` folder. +``` +git clone https://github.com/LabsDevelopment/Octobot +cd Octobot +``` +4. Run Octobot using `dotnet` with `BOT_TOKEN` variable. +``` +dotnet run BOT_TOKEN='ENTER_TOKEN_HERE' +``` + ## Contributing When it comes to contributing to the project, the two main things you can do to help out are reporting issues and