Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #5

Open
1 of 5 tasks
mayberryrfd opened this issue Feb 7, 2018 · 2 comments
Open
1 of 5 tasks

Improve README #5

mayberryrfd opened this issue Feb 7, 2018 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@mayberryrfd
Copy link
Contributor

mayberryrfd commented Feb 7, 2018

This is fairly open-ended. There are a lot of great READMEs to copy out there. Find one, adapt it for this project, and copy it mercilessly.

Areas of Significant Need:

  • Windows setup
    • PostgreSQL installation
    • Environment setup (WSL2 vs. native, environment variables, .env files, etc.)
  • Discord setup (API token, creating a bot, etc. Most likely best served by linking to other resources like blog posts that document it already)
  • Refine the *nix instructions. (Improve clarity & coherence, and document more edge cases)
@mayberryrfd mayberryrfd added the enhancement New feature or request label Feb 7, 2018
@onelson
Copy link
Contributor

onelson commented Feb 19, 2018

The biggest need I can see immediately is some info about setup for developers. I'm assuming you need to hook this up to discord somehow in order to get working.

@mayberryrfd
Copy link
Contributor Author

Yes, great place to improve that. But so far it is not really necessary to connect to Discord at all in dev.

The serenity crate guarantees an interface to the Discord API so i just have to code to serenity and make sure the biz logic I write works via tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants