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

add docs #2

Open
6 of 8 tasks
josmas opened this issue May 23, 2016 · 0 comments
Open
6 of 8 tasks

add docs #2

josmas opened this issue May 23, 2016 · 0 comments

Comments

@josmas
Copy link
Member

josmas commented May 23, 2016

docs to readme to:

  • what is this library for
  • install
  • basic instantiation
  • basic usage

dev docs to readme to:

  • forking/cloning for local development
  • contribution rules (copy from PaperBadger)
  • testing guidelines
  • architecture and main design decisions
@josmas josmas self-assigned this May 23, 2016
@josmas josmas added this to the Before MSL Sprint 16 milestone May 23, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant