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

practical documentation #16

Open
2 of 3 tasks
vhewes opened this issue Oct 10, 2022 · 0 comments
Open
2 of 3 tasks

practical documentation #16

vhewes opened this issue Oct 10, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@vhewes
Copy link
Collaborator

vhewes commented Oct 10, 2022

include section in top-level README summarising the docker container environment, and how to run with a data release file.

  • update README
  • create readthedocs page
  • API documentation on readthedocs
@vhewes vhewes added the documentation Improvements or additions to documentation label Oct 10, 2022
@vhewes vhewes self-assigned this Oct 10, 2022
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