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

[docs] Create a comprehensive README #6

Open
5 tasks
pandafy opened this issue Oct 8, 2020 · 0 comments
Open
5 tasks

[docs] Create a comprehensive README #6

pandafy opened this issue Oct 8, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@pandafy
Copy link
Member

pandafy commented Oct 8, 2020

README should contain separate steps for users and developers.

For users, it should contain

  • Commands supported by Discord Bot
  • Commands supported by CLI
  • Steps to initialise the CLI

For developers, it should contain:

  • Steps to create a development environment
  • How to deploy the backend to a server
@pandafy pandafy added the documentation Improvements or additions to documentation label Oct 8, 2020
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

No branches or pull requests

1 participant