update readme

This commit is contained in:
dece 2024-08-25 21:15:26 +02:00
parent af14d5d6f0
commit ae70817ac8

View file

@ -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
```