Maki/README.md

# Maki - Discord bot written in Python
### The discord bot that does things.

---

## Running Maki
Maki relies on Python 3.4+ and the latest discord.py version.  
A Dockerfile exists to handle these requirements automatically. Use `build.sh` to create the maki container image, and `run.sh` to start the bot.  
Be sure to have created `secret.py` with the required tokens before running `build.sh`.

If you would prefer not to use docker, ensure you have at least Python 3.4, and use `pip install -r requirements.txt` to install the required Python libraries. Then run `bot.py`.

## Required Files
- You will require a Discord Application for Maki to use, the token for which should be stored in a file called secret.py:
```python
token = '<Discord Application Token>'
lfmkey = '<last.fm API key>'
steamkey = '<Steam API key>'
```
- Maki uses JSON files to store data persistently. These will be created automatically in the `persist` directory.

## License
Copyright 2019, Zac Herd.  
All Rights Reserved.  
Licensed under the BSD 3-clause License.  
See LICENSE.md for a full copy of the license text.
Initial commit, v0.4 2016-03-30 16:28:59 -04:00			`# Maki - Discord bot written in Python`
removed server-specific text from README 2016-11-30 05:14:23 -05:00			`### The discord bot that does things.`
Initial commit, v0.4 2016-03-30 16:28:59 -04:00
			`---`

			`## Running Maki`
Docker! Updated README and added build/run scripts. Bootstrap script is obsolete. 2019-02-25 09:04:27 -05:00			`Maki relies on Python 3.4+ and the latest discord.py version.`
			A Dockerfile exists to handle these requirements automatically. Use `build.sh` to create the maki container image, and `run.sh` to start the bot.
			Be sure to have created `secret.py` with the required tokens before running `build.sh`.

			If you would prefer not to use docker, ensure you have at least Python 3.4, and use `pip install -r requirements.txt` to install the required Python libraries. Then run `bot.py`.
Initial commit, v0.4 2016-03-30 16:28:59 -04:00
Added persistent data using JSON, v0.5.0 2016-03-30 18:33:53 -04:00			`## Required Files`
2017 readme and license update 2017-04-22 11:03:11 -04:00			`- You will require a Discord Application for Maki to use, the token for which should be stored in a file called secret.py:`
readme code format fix 2017-04-22 11:05:42 -04:00			```python
2017 readme and license update 2017-04-22 11:03:11 -04:00			`token = '<Discord Application Token>'`
			`lfmkey = '<last.fm API key>'`
			`steamkey = '<Steam API key>'`
			```
Docker! Updated README and added build/run scripts. Bootstrap script is obsolete. 2019-02-25 09:04:27 -05:00			- Maki uses JSON files to store data persistently. These will be created automatically in the `persist` directory.
Initial commit, v0.4 2016-03-30 16:28:59 -04:00
			`## License`
Docker! Updated README and added build/run scripts. Bootstrap script is obsolete. 2019-02-25 09:04:27 -05:00			`Copyright 2019, Zac Herd.`
2017 readme and license update 2017-04-22 11:03:11 -04:00			`All Rights Reserved.`
			`Licensed under the BSD 3-clause License.`
			`See LICENSE.md for a full copy of the license text.`