qrm2/README.md
0x5c 90738d81de
Docker: We have docs, Doc!
- Added documentation on running the bot
    with docker-compose and docker.
2019-12-15 22:53:40 -05:00

33 lines
773 B
Markdown

# qrm, a Bot for Discord
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
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
```
## Copyright
Copyright (C) 2019 Abigail Gold, 0x5c
This program is released under the terms of the GNU General Public License,
version 2. See `COPYING` for full license text.