upating readme
This commit is contained in:
parent
a3f73b1cd6
commit
8b961677d8
23
README.md
23
README.md
@ -2,16 +2,32 @@
|
|||||||
|
|
||||||
A discord bot for the trifecta discord channel
|
A discord bot for the trifecta discord channel
|
||||||
|
|
||||||
|
### What does this bot do? ###
|
||||||
|
* A quick and dirty explanation would be to read the `help.py` file, but to give a summary
|
||||||
|
* This is a chat bot of sorts that connects to our [discord](https://discordapp.com/) channel and interacts with us via chat commands
|
||||||
|
* This bot has also been an ongoing learning expierence for several members of the discord channel. With this bot, I have been able to teach the repo members:
|
||||||
|
* Docker
|
||||||
|
* Git
|
||||||
|
* Python
|
||||||
|
* CI/CD
|
||||||
|
* Collabrative coding practices
|
||||||
|
* Testing methodologies
|
||||||
|
* Code Accountability
|
||||||
|
|
||||||
|
|
||||||
### What is this repository for? ###
|
### What is this repository for? ###
|
||||||
|
|
||||||
* Here we track issues and collaborate on the bot
|
* Here we track issues and collaborate on the bot
|
||||||
|
|
||||||
### How do I get set up? ###
|
### How do I get set up? ###
|
||||||
|
|
||||||
* You'll need to install docker
|
* Install docker
|
||||||
* as root (`sudo -s`)
|
* as root (`sudo -s`)
|
||||||
* `curl -Ls get.docker.com | bash`
|
* `curl -Ls get.docker.com | bash`
|
||||||
* Give yourself docker permissions `sudo usermod -aG docker <your username>`
|
* Give yourself docker permissions `sudo usermod -aG docker <your username>`
|
||||||
|
* Or if you are using OS X
|
||||||
|
* `curl -L get.macapps.link/en/docker | bash`
|
||||||
|
* Complete the setup steps
|
||||||
|
|
||||||
### Testing your changes ###
|
### Testing your changes ###
|
||||||
* Build the testing container by running
|
* Build the testing container by running
|
||||||
@ -24,8 +40,9 @@ A discord bot for the trifecta discord channel
|
|||||||
### Contribution guidelines ###
|
### Contribution guidelines ###
|
||||||
|
|
||||||
* Make your changes
|
* Make your changes
|
||||||
* create a pull request
|
* Test the bot by running `test-dragon-bot.sh` and interacting with the bot in the #test_channel
|
||||||
* copy-paste the output of `test_container.sh` on your pull request to prove everything worked
|
* Create your pull request
|
||||||
|
* bonus points if you include screenshots, terminal output, or even videos of the features on the PR
|
||||||
|
|
||||||
|
|
||||||
### Who do I talk to? ###
|
### Who do I talk to? ###
|
||||||
|
Loading…
x
Reference in New Issue
Block a user