From ae70817ac88144bd3c088dc0f1cac7077e2e71a4 Mon Sep 17 00:00:00 2001 From: dece Date: Sun, 25 Aug 2024 21:15:26 +0200 Subject: [PATCH] update readme --- README.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d579da5..950db78 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ -Edm0nd -====== +# Edm0nd New version of the infamous IRC bot. +## Installation -Installation ------------- +Clone the repository and create a virtualenv to install your dependencies. -Clone the repository. +```bash +pip install -r requirements.txt +python -m edmond +``` -The preferred installation way is using Docker: +You can also use the provided Dockerfile if that's your thing: ```bash # Build image with dependencies. @@ -24,11 +26,3 @@ docker run -d \ edmond \ -c config.json ``` - -Else you can install dependencies and run it in a virtual env: - -```bash -pipenv install -pipenv run pip install -r edmond/plugins/requirements.txt -pipenv run python -m edmond -```