From 916067632df22156a0f082418a722d95f7bb933d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Abdulkadir=20Furkan=20=C5=9Eanl=C4=B1?= Date: Sun, 21 Jan 2024 10:46:40 +0100 Subject: [PATCH] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Abdulkadir Furkan Şanlı --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a521ed3..f864d83 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,30 @@ ParkerBot is a Matrix bot that monitors a channel for YouTube links and generates weekly playlists from them. -## Installation +## Running locally 1. Clone the repo 2. Install the dependencies, preferably in a venv: - ```shell - python3 -m venv venv - source ./venv/bin/activate - pip3 install -r requirements.txt - ``` + ```shell + python3 -m venv venv + source ./venv/bin/activate + pip3 install -r requirements.txt + ``` +3. Copy `[example.env](example.env)` to `.env`, customize it. +4. Source `.env`: + ```shell + source .env + ``` +3. Execute the app: + ```shell + ./main.py + ``` -## Running +## Running as a container -1. Execute `main.py`: `./main.py` +1. Customize the compose.yml if necessary, you might want to change the data + volume's path or make it a named volume. +3. Copy `[example.env](example.env)` to `.env` and customize it. +2. ```shell + podman-compose up -d + ```