Add README.md

This commit is contained in:
Clarth 2023-11-14 17:33:44 -05:00
parent 1e22a218cb
commit 194edf86fb
1 changed files with 54 additions and 0 deletions

54
README.md Normal file
View File

@ -0,0 +1,54 @@
<img src="https://i.imgur.com/Q8K4Ujn.jpg" alt="Centered Image" width="300" height="300">
# Set Up Guide
1. Create a python virtual environment
`python3 -m venv /absolute/path/to/venv`
2. Install depends in venv
`/absolute/path/to/venv/bin/pip3 install pyTelegramBotAPI`
3. Edit tg_print.py with correct telegram API token and change directories variables.
4. Start the script
`/absolute/path/to/venv/bin/python tg_print.py`
## Unit file
```
[Unit]
Description=tg_spotdl
After=network-online.target
[Service]
User=nobody
ExecStart=/absolute/path/to/venv/bin/python /absolute/path/to/start.py
Restart=always
RestartSec=5s
RuntimeMaxSec=12h
[Install]
WantedBy=multi-user.target
```
## Start Script
Recommend running in a screen or tmux.
```
#!/bin/bash
/absolute/path/to/venv/bin/python /absolute/path/to/start.py
exit
```
# Usage
1. Send a file to the chat or directly to the bot in a PM.
2. Collect paper from the printer.
## Useful Links
https://github.com/eternnoir/pyTelegramBotAPI