From 1da4292952ebe8734c298a7d4bed3739dc649cb0 Mon Sep 17 00:00:00 2001 From: Byte Dice Date: Mon, 24 Feb 2025 19:41:05 +0100 Subject: [PATCH] update README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9867670..d9dc397 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@ An automation tool for Byte Dice. It's both a Discord and Reddit bot in one prog **You can learn more about copyright by reading the full [license](/LICENSE.txt).** ## How to run -**Dependecies:** This program uses Rust (v1.82.0) and Python (v3.11.4), you can likely use other versions if they are compatible. This program also uses these Python modules: +### Dependecies: + +This program uses Rust (v1.82.0) and Python (v3.11.4), you can likely use other versions if they are compatible. This program also uses these Python modules: * asyncio * asyncpraw * asyncprawcore @@ -24,7 +26,9 @@ An automation tool for Byte Dice. It's both a Discord and Reddit bot in one prog * typing * websockets -**Environment variables:** +You can install Python modules by running `$ pip install {module}` or `$ python -m pip install {module}` in a terminal. + +### Environment variables: | **Name** | **Description** | | --- | --- | | `ASSISTANT_TOKEN` | The Discord bot token. | @@ -35,9 +39,7 @@ An automation tool for Byte Dice. It's both a Discord and Reddit bot in one prog | `ASSISTANT_R_NAME` | The username of the Reddit bot/account. | | `ASSISTANT_R_PASS` | The password for the Reddit bot/account. | -You can install Python modules by running `$ pip install {module}` or `$ python -m pip install {module}` in a terminal. - -**How to run:** +### How to run: * Download the code (and extract if needed). * Open a terminal and CD to the downloaded folder. * Run `$ cargo run`. There are more options when running. You can view a list of those using `$ cargo run -- --help`.