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

documentation! #12

Open

8 tasks

mapsam opened this issue Jun 15, 2016 · 0 comments

Milestone

Contributor

mapsam commented Jun 15, 2016 •

edited

Loading

Documenting this whole thing is going to be epic. A very general, evolving list of things to keep in mind (please edit inline!):

All purpose API docs - for now we are not thinking about inline documentation (i.e. documentationjs).
- API.md
- C++ examples
- JS examples
installation, os & compiler requirements Build and Test Doc #48
README.md - wat even is this thing Create Proper README #4
CONTRIBUTING.md add a CONTRIBUTING.md #10
developer docs around algorithm choices, code structure, tests, etc. - possibly in a separate repo?

cc @springmeyer @mourner @tcql @flippmoke @jakepruitt @GretaCB @ericfischer

flippmoke added this to the 1.0 milestone

mapsam mentioned this issue

Build and Test Doc #48

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment