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

Write Documentation #113

Open
5 tasks
mgermain opened this issue Apr 5, 2016 · 0 comments
Open
5 tasks

Write Documentation #113

mgermain opened this issue Apr 5, 2016 · 0 comments
Assignees
@bouthilx
Labels
CCW doc

Comments

@mgermain
Copy link
Member

mgermain commented Apr 5, 2016 •
edited
Loading

As suggested in #112 we should write some documentation.

  • Set up a ReadTheDoc, learn the good practices and how to sync it with the README.md
  • Add what we have in the README.md to the RTD in a cleaner way. Installation, basic usage, ...
  • Explain all features
  • Expand usage section + advanced usage
  • Describe purpose and the hierarchy of SMARTDISPATCH_LOGS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bouthilx bouthilx

Labels
CCW doc
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mgermain @bouthilx