From 501da7b943950c130b34657162afc8ad69f093d4 Mon Sep 17 00:00:00 2001 From: Macintosh II <95250141+mctaylors@users.noreply.github.com> Date: Wed, 4 Oct 2023 17:03:52 +0300 Subject: [PATCH] Add building & running instructions Signed-off-by: Macintosh II <95250141+mctaylors@users.noreply.github.com> --- docs/README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/docs/README.md b/docs/README.md index 7d899f9..ae986f1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,6 +22,55 @@ 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) +## Building & running + +
Instructions for Linux +
+ +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. Open Terminal +4. Clone this repository and open `Octobot` folder. +``` +git clone https://github.com/LabsDevelopment/Octobot +cd Octobot +``` +5. Build Octobot using `dotnet` and open `bin\Debug\net7.0` folder. +``` +dotnet build +cd bin\Debug\net7.0 +``` +6. Create a `BOT_TOKEN` environment variable with a bot token from Discord Developer Portal and run Octobot. +``` +export BOT_TOKEN='ENTER_TOKEN_HERE' +./Octobot +``` + +
+
Instructions for Windows +
+ +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. Open PowerShell +4. Clone this repository and open `Octobot` folder. +``` +git clone https://github.com/LabsDevelopment/Octobot +cd Octobot +``` +5. Build Octobot using `dotnet` and open `bin/Debug/net7.0` folder. +``` +dotnet build +cd bin/Debug/net7.0 +``` +6. Create a `BOT_TOKEN` environment variable with a bot token from Discord Developer Portal and run Octobot. +``` +$ENV:BOT_TOKEN='ENTER_TOKEN_HERE' +.\Octobot.exe +``` + +
+ ## Contributing When it comes to contributing to the project, the two main things you can do to help out are reporting issues and