Skip to content

Clean up bot - #1

Open
jBenderToledo wants to merge 3 commits into
masterfrom
improvedReadme
Open

jBenderToledo wants to merge 3 commits into
masterfrom
improvedReadme

Conversation

@jBenderToledo

Copy link
Copy Markdown
Contributor
  • Wrote a more descriptive readme format that helps use and maintainability (such as only mentioning the command prefix once

Added a description of all available commands for use.
Didn't even think to just leave the command symbol in only one place for maintainability reasons.
Explained the basics of mentions for any examples given with commands.
@jBenderToledo
jBenderToledo marked this pull request as ready for review July 30, 2019 05:14
@joey-kilgore
joey-kilgore self-requested a review July 31, 2019 00:03
@joey-kilgore

Copy link
Copy Markdown
Member

So this is just an update to the readme?

@jBenderToledo

jBenderToledo commented Jul 31, 2019

Copy link
Copy Markdown
Contributor Author

So this is just an update to the readme?

Effectively, yeah. I don't know how to put more than one file into a pull request via GitHub.

@joey-kilgore

Copy link
Copy Markdown
Member

Effectively, yeah. I don't know how to put more than one file into a pull request via GitHub. Once I get a VM-or-better instance of Linux on a flash drive, I'll improve on it and see what I can do.

Pull requests are done with entire branches. Just make one branch and do all the edits you need to. Then you can make a pull request to merge your branch into master. (Note that to do all this you should clone the repo on the machine not edit files on the internet)

@jBenderToledo

jBenderToledo commented Jul 31, 2019

Copy link
Copy Markdown
Contributor Author

Effectively, yeah. I don't know how to put more than one file into a pull request via GitHub. Once I get a VM-or-better instance of Linux on a flash drive, I'll improve on it and see what I can do.

Pull requests are done with entire branches. Just make one branch and do all the edits you need to. Then you can make a pull request to merge your branch into master. (Note that to do all this you should clone the repo on the machine not edit files on the internet)

Wait, I can do that? Let me look into it. Does it clone all branches or just the one that I need?

@joey-kilgore

Copy link
Copy Markdown
Member

Besides this, we should include (prior to the list of commands) how to setup the bot
ie
pip install discord
and create a file called keys.json and fill it with the following. Note that you will need to have already gone through the process of creating a discord bot

{  
"discordKey":"<PUT YOUR KEY HERE>"  
}  

@joey-kilgore joey-kilgore added the documentation Improvements or additions to documentation label Jul 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants