A proper readme

This commit is contained in:
Sophie Mondz 2022-02-28 12:58:34 -06:00 committed by GitHub
parent 801539e4ac
commit 418878981f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 4 deletions

View File

@ -1,5 +1,13 @@
# Anitrox Dev Branch
# anitrox_unstable
This is for the ultra-fresh builds of Anitrox and is **very** unstable. It is only avaliable in Anitrox Central.
# These builds are UNSUPPORTED and you will not be able to recieve support if there's a problem. It's best you wait for a new build if you're having a problem.
# Anitrox Dev Branch (anitrox_unstable)
This is the development branch for Anitrox, If you want those fresh hot Anitrox builds right from the oven, you've come to the right place!
# Dependencies to get started
To begin, you will need to satisfy the following dependencies:
Node.JS: 14
npm: 6.14
# Let's get this ~~party~~ bot started!
For first time start up, You will need to run ``npm install`` to install the needed npm packages.
Afterwards fill out the ``config-example.json`` and rename it to ``config.json``, then just run ``node start.js``!
⚠️ If you don't specify the Owner ID, Some commands such as the bot controls will be unusable!
# Support
Anitrox isn't really supported but you can get help from the Discord server if you need any: discord.gg/5nQtMNpf43