diff --git a/README.md b/README.md index f6fb89c..de77938 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ # scnewsbot -A bot for the r/starcitizen Discord server. \ No newline at end of file +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) \ No newline at end of file diff --git a/example.env b/example.env new file mode 100644 index 0000000..2f37306 --- /dev/null +++ b/example.env @@ -0,0 +1,3 @@ +DISCORD_TOKEN=Your Discord bot token. +JISHAKU_NO_UNDERSCORE=1 +JISHAKU_HIDE=1 \ No newline at end of file