README.md created online with Bitbucket

This commit is contained in:
Luke Robles 2017-08-08 23:25:30 +00:00
parent 429a64cb7a
commit d804e3e2e2

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# README #
A discord bot for the trifecta discord channel
### What is this repository for? ###
* Here we track issues and collaborate on the bot
### How do I get set up? ###
* You'll need to install docker
* as root (`sudo -s`)
* `curl -Ls get.docker.com | bash`
### Testing your changes ###
* There is a bash file in the root of the repo, `test_container.sh`
* run this to validate your python syntax. On first run, it will take a while to build
### Contribution guidelines ###
* Make your changes
* create a pull request
* copy-paste the output of `test_container.sh` on your pull request to prove everything worked
### Who do I talk to? ###
* Bad dragon in discord