zomo/1800queue
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
ashley zomo
2022-01-27 20:34:10 -06:00
parent 9067a67bd5
commit c9f9ba366a
1 changed files with 60 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@@ -1,17 +1,73 @@
<!-- markdownlint-disable MD033 -->
# 1800queue
## Prerequirements
Download and install [Node.js](https://nodejs.org/en/)
## Installation
## Automatic Installation
1. Download and extract this repository
2. Open the `scripts` folder
3. Open the folder that corresponds with your operating system
4. Run the `install` file
## Manual Installation
1. Download and extract this repository
2. Open the directory that contains `package.json` in your command prompt or terminal
3. Run the command `npm install`
4. Create a file called `token` in the same directory and enter your bot client's token
## Running
## Starting
1. Open the directory that contains `package.json` in your command prompt or terminal
2. Run the command `npm start`
1. Open the `scripts` folder
2. Open the folder that corresponds with your operating system
3. Run the `start` file
## Other Start Scripts
<details>
<summary>Mac/Linux Screen</summary>
<br>
<p>Screen allows the bot to run in the background without a terminal present</p>
<p>Installing</p>
<ul>
<li>
<p>Mac</p>
<ol>
<li>Install <a href="https://formulae.brew.sh/"><code>Homebrew</code></a></li>
<li>Open the terminal and run the command <code>brew install screen</code></li>
</ol>
</li>
<li>
<p>Linux</p>
<ul>
<li>Use your distribution's package manager to find <code>screen</code></li>
</ul>
</li>
</ul>
</details>
<details>
<summary>Mac/Linux Tmux</summary>
<br>
<p>Tmux allows the bot to run in the background without a terminal present</p>
<p>Installing</p>
<ul>
<li>
<p>Mac</p>
<ol>
<li>Install <a href="https://formulae.brew.sh/"><code>Homebrew</code></a></li>
<li>Open the terminal and run the command <code>brew install tmux</code></li>
</ol>
</li>
<li>
<p>Linux</p>
<ul>
<li>Use your distribution's package manager to find <code>tmux</code></li>
</ul>
</li>
</ul>
</details>