qrm2/README.md
classabbyamp 6329718d29
Contribution and PR Guidelines (#219)
* Create pull_request_template.md
* add contribution guidelines

fixes #160
2020-09-27 16:18:09 -04:00

41 lines
1.0 KiB
Markdown

# qrm, a Bot for Discord
[![Discord](https://discordapp.com/api/guilds/656888365886734340/widget.png?style=shield)](https://discord.gg/SwyjdDN)
A discord bot with ham radio functionalities.
An independent rewrite of qrmbot-discord.
## Running
### With Docker
See [README-DOCKER.md](./README-DOCKER.md)
### Without Docker
Requires Python 3.7 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).
```
$ 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
Check out the [contribution guidelines](/CONTRIBUTING.md) for more information about how to contribute to this project.
## Copyright
Copyright (C) 2019-2020 Abigail Gold, 0x5c
This program is released under the terms of the GNU General Public License,
version 2. See `COPYING` for full license text.