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 documentation #168

Open
jjeising opened this issue Apr 25, 2018 · 0 comments
Open

Add documentation #168

jjeising opened this issue Apr 25, 2018 · 0 comments
Labels

Comments

@jjeising
Copy link
Member

To use this for different projects and add ease of use for outside users we need aber better documentation of general concepts and workflows.

I would suggest adding a markdown based documentation in a docs/ folder. An example of a more complex documentation in markdown can be seen here.

I've also added a project and a label to gather contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant