update README
This commit is contained in:
@@ -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`.
|
||||
|
||||
Reference in New Issue
Block a user