From 23bd99db7e280012d0bef76dc997499b327ef1ff Mon Sep 17 00:00:00 2001 From: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com> Date: Thu, 25 Aug 2022 20:20:01 +0000 Subject: [PATCH] chore: small readme fixes --- template/bigbot/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/template/bigbot/README.md b/template/bigbot/README.md index fa94d7472..d4d8f0086 100644 --- a/template/bigbot/README.md +++ b/template/bigbot/README.md @@ -4,6 +4,23 @@ Support: This template is designed for bots that aim or are already in millions of Discord servers. It is written with Node.js as currently Deno & Bun are not ready to run something at such a scale. The general idea of this template can be modified for any other runtime if this improves in the future. +## Setup + +1. Run a find all for `// SETUP-DD-TEMP:` and follow all instructions and delete the comments as you finish them. + +## Startup + +To start your bot, you will need to start a few processes. The instructions below will use `node` but you can use something like `pm2` to help keep your processes alive. + +Please compile everything first with `tsc`. + +- Start REST + - `ts-node src/rest/index.ts` +- Start Gateway + - `ts-node src/gateway/index.ts` +- Start Bot + - `ts-node src/bot/index.ts` + ## Improvements - Change configs.ts file to use an .env file. \ No newline at end of file