diff --git a/docs/README.md b/docs/README.md index ae986f1..be73f87 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,54 +22,19 @@ 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 -
+## 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. Open Terminal -4. Clone this repository and open `Octobot` folder. +3. 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. +4. Run Octobot using `dotnet` with `BOT_TOKEN` variable. ``` -dotnet build -cd bin\Debug\net7.0 +dotnet run BOT_TOKEN='ENTER_TOKEN_HERE' ``` -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