update readme
This commit is contained in:
parent
af14d5d6f0
commit
ae70817ac8
22
README.md
22
README.md
|
@ -1,16 +1,18 @@
|
||||||
Edm0nd
|
# Edm0nd
|
||||||
======
|
|
||||||
|
|
||||||
New version of the infamous IRC bot.
|
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
|
```bash
|
||||||
# Build image with dependencies.
|
# Build image with dependencies.
|
||||||
|
@ -24,11 +26,3 @@ docker run -d \
|
||||||
edmond \
|
edmond \
|
||||||
-c config.json
|
-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
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in a new issue