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

Update repository documentation #2253

Open
cdbethune opened this issue Feb 9, 2021 · 0 comments
Open

Update repository documentation #2253

cdbethune opened this issue Feb 9, 2021 · 0 comments
Assignees
@cdbethune
Labels
maintenance

Comments

@cdbethune
Copy link
Collaborator

The repo readme has grown organically over time and is due to for a re-organization. The main things we need it to cover off are:

  1. Overall project description
  2. Repository organisation
  3. Repository dependencies - ie. distil-auto-ml, d3m, automl-api
  4. Quick start instructions - pulling and running latest Docker images (not running from source)
  5. Developer instructions - installing dependencies, running via witch/yarn etc.
  6. Additional developer instructions - rebuilding grammar
@cdbethune cdbethune self-assigned this Feb 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cdbethune cdbethune

Labels
maintenance
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cdbethune