Modify readme #36
Merged
Modify readme #36
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
jspmic
commented
Jul 27, 2024
jspmic
commented
- [ x ] Project's Image
- [ x ] Installation Procedure
- [ x ] Setup Procedure
- [ ] Bot's Usage
- [ x ] Conclusion and Key Achievements
- Added a conclusion - Added the Installation procedure - Added the Setup procedure
gustavwilliam
requested changes
Jul 31, 2024
|
|
||
| 3. **Set Up Your Environment Variables**: | ||
| - Create a .env file in the root of your project and add your Discord API Token: `DISCORD_BOT_KEY="your-discord-token-here"` | ||
|
|
There was a problem hiding this comment.
We should have a step for updating the emojis used in config.py. They should change the IDs to their own emojis' IDs, after they add the emojis under bot/assets/icons to a server or their bot application. Otherwise the bot won't work (unless its invited into our server where the emojis already exist)
README.md
Outdated
|
|
||
| 3. add or set `DISCORD_BOT_KEY=[your_bot_key]` with bot's key. | ||
| For more information, Consult The [Discord Developer Portal](https://discord.com/developers/docs/intro) Documentation. |
There was a problem hiding this comment.
We also have a dev guide for setting up the bot in discord's dev portal. We should either link to that or integrate that text into the README. IMO integrating it into the readme would make the most sense.
Co-authored-by: Gustav Odinger <[email protected]>
Co-authored-by: Gustav Odinger <[email protected]>
Co-authored-by: Gustav Odinger <[email protected]>
Co-authored-by: Gustav Odinger <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.