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

readme update

Browse Source
This commit is contained in:
Ian
2024-03-10 00:24:49 -05:00
parent f76b86416a
commit eb05229e34
1 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -1,11 +1,10 @@
# scnewsbot
A bot for the r/starcitizen Discord server.
# SC News Bot
The production version of the SC News Bot used by the r/StarCitizen Discord server for the production of news posts.
## 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 also be `py`, `python3` or `python3.11` depending on your operating system).
## Details
- Coded by Ian (hencaric) and mudkip
- Original Code: https://github.com/mudkipdev/scnewsbot
- Join https://discord.gg/starcitizen for the best Star Citizen community on the internet
![](https://i.pinimg.com/originals/a8/3a/54/a83a543f8f669534b93eb503d0cb9e3d.jpg)
![](https://cdn.discordapp.com/attachments/1113146864804573285/1214590384001515560/41bannerEisenlowe.png?ex=65f9aa71&is=65e73571&hm=1cd99b04925a778d05b6d1cd1ae804af083760b0c11cc7ae96d44491b1fcb3ff&)