FumeNodes/SCNewsBot
1
0
Fork 0
mirror of https://github.com/hencaric/SCNewsBot.git synced 2026-08-16 22:46:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

add installation guide

Browse Source
This commit is contained in:
mudkipdev
2023-05-07 14:18:11 -06:00
parent 3fd4729766
commit e9641779f3
2 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -1,2 +1,11 @@
# scnewsbot
A bot for the r/starcitizen Discord server.
A bot for the r/starcitizen Discord server.
## Installation
1. Make sure you have installed [Python](https://python.org) (>=3.11), [Git](https://git-scm.org), and [Poetry](https://pypi.org/project/poetry).
2. Clone the repository to your hard drive. (`git clone https://github.com/mudkipdev/scnewsbot`)
3. Run `cd scnewsbot` and `poetry install` to install the required dependencies.
4. Copy the `example.config.toml` and `example.env` files to `config.toml` and `.env` respectively.
5. Edit the config files to your liking, then run the bot using `poetry run python scnewsbot` (This might be `py`, `python3` or `python3.11` depending on your operating system).
![](https://c1.staticflickr.com/3/2917/33396432932_f9549759a8_o.png)

3
example.env Normal file
View File

@@ -0,0 +1,3 @@
DISCORD_TOKEN=Your Discord bot token.
JISHAKU_NO_UNDERSCORE=1
JISHAKU_HIDE=1