miaowware
/
qrm2
mirror of https://github.com/miaowware/qrm2.git
1
0
Fork 0
Code Issues Actions Projects Releases Wiki Activity

Merge pull request #378 from miaowware/dev-deps 

add system dependencies to README and DEVELOPING
This commit is contained in:
classabbyamp 2021-03-26 03:49:16 -04:00 committed by GitHub
parent 89e26dbd2b aaec204c43
commit bb3ee319b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
DEVELOPING.md
View File

@ -8,6 +8,7 @@
1. Make sure the `master` branch is up to date, then make yourself a new branch with a descriptive name.
1. Once the forked repo is cloned and on the proper branch, you can set up the development environment.
1. Install python 3.9 or higher.
1. Install `libcairo` and `libjpeg`. Package names may vary by distro or OS.
1. Run `make dev-install`.
This should install everything you need to develop and run qrm.
1. [Create a bot and token][2], and add it to `data/keys.py`.

2
README.md
View File

@ -18,6 +18,8 @@ Requires Python 3.9 or newer.
Prep the environment. For more information on extra options, see the [quick-bot-no-pain Makefile documentation](https://github.com/0x5c/quick-bot-no-pain/blob/master/docs/makefile.md).
Install `libcairo` and `libjpeg` (package names may vary by distro or OS). Then run:
```
$ make install
```