qrm2/README.md

45 lines
1.5 KiB
Markdown
Raw Normal View History

# qrm, a Bot for Discord
2019-10-03 19:38:12 -04:00
2019-12-25 01:55:25 -05:00
[![Discord](https://discordapp.com/api/guilds/656888365886734340/widget.png?style=shield)](https://discord.gg/SwyjdDN)
2019-12-18 11:47:47 -05:00
2019-10-03 19:38:12 -04:00
A discord bot with ham radio functionalities.
2019-10-03 20:19:07 -04:00
An independent rewrite of qrmbot-discord.
## Running
### With Docker
See [README-DOCKER.md](./README-DOCKER.md)
### Without Docker
Requires Python 3.9 or newer.
2020-03-30 19:00:38 -04:00
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
```
Run. For more information on options, see the [quick-bot-no-pain run.sh documentation](https://github.com/0x5c/quick-bot-no-pain/blob/master/docs/run.sh.md).
```
$ run.sh
```
## Contributing
2021-03-19 02:57:21 -04:00
Check out the [development](/DEVELOPING.md) and [contribution guidelines](https://github.com/miaowware/.github/blob/master/CONTRIBUTING.md) for more information about how to contribute to this project.
All issues and requests related to resources (including maps, band charts, data) should be added in [miaowware/qrm-resources](https://github.com/miaowware/qrm-resources).
2019-10-04 18:05:57 -04:00
## Copyright
Copyright (C) 2019-2021 classabbyamp, 0x5c
2019-10-04 18:05:57 -04:00
This program is released under the terms of the *Québec Free and Open-Source Licence Strong Reciprocity (LiLiQ-R+)*, version 1.1.
See [`LICENCE`](LICENCE) for full license text (Français / English).