muskit/NijiHolo_EN_ID_Bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README.md

Browse Source
This commit is contained in:
muskit
2024-02-02 02:23:09 -08:00
parent 6675165906
commit 8fda473316
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -6
View File
@@ -6,13 +6,20 @@ Twitter bot that tracks cross-company interactions between the non-JP branches o
**This project was created to run [this account](https://twitter.com/NijiHolo_EN_ID).**
## Running
Install dependencies.
```
pip install -r requirements.txt
```
Setup the `.env` in the project root. Refer to the `.env` section for variables.
With the way packages are setup, **you must have Docker installed and running!!**
Run the program from project root (not in `src`). Refer to the following section for options.
Setup the `.env` in the project root. Refer to the [`.env`](#env) section for variables.
Build and run the Docker container:
```bash
# to run attached (can CTRL+P,CTRL+Q to detach)
sh run.sh
# ... or to run headless
sh run_detached.sh
```
If attached to a container prepared by Dockerfile, you can run the program from project root (not in `src`). Refer to the following section for options.
```
python src/main.py
```