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.

Sign up for GitHub

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

Jump to bottom

Improve README #35

Open
yyyliu opened this issue Oct 23, 2020 · 0 comments
Open

Improve README #35

yyyliu opened this issue Oct 23, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@yyyliu
Copy link
Member

yyyliu commented Oct 23, 2020

  1. Add a section for how to report issues
  2. Note python version, OS, and other requirements. (Some examples need requirement.txt, some needs Rscript and R dependencies)
  3. Be clear which example does not support boba-server
  4. Include a dataset to test if boba-server is installed successfully
@yyyliu yyyliu added the documentation Improvements or additions to documentation label Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@yyyliu