ByteDice/ByteDiceAssistant
1
0
Fork 0
Code Issues Pull Requests Actions Releases Wiki Activity

update README

Browse Source
This commit is contained in:
ByteDice
2025-02-24 19:41:05 +01:00
parent 8939334f84
commit 1da4292952
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -5
View File
@@ -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).** **You can learn more about copyright by reading the full [license](/LICENSE.txt).**
## How to run ## 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 * asyncio
* asyncpraw * asyncpraw
* asyncprawcore * asyncprawcore
@@ -24,7 +26,9 @@ An automation tool for Byte Dice. It's both a Discord and Reddit bot in one prog
* typing * typing
* websockets * 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** | | **Name** | **Description** |
| --- | --- | | --- | --- |
| `ASSISTANT_TOKEN` | The Discord bot token. | | `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_NAME` | The username of the Reddit bot/account. |
| `ASSISTANT_R_PASS` | The password for 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). * Download the code (and extract if needed).
* Open a terminal and CD to the downloaded folder. * 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`. * Run `$ cargo run`. There are more options when running. You can view a list of those using `$ cargo run -- --help`.