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

WIP: Documentation and Examples #257

Merged
merged 1 commit into from Dec 31, 2018
Merged

WIP: Documentation and Examples #257

merged 1 commit into from Dec 31, 2018

Conversation

fdietze
Copy link
Member

@fdietze fdietze commented Nov 8, 2018

I took the time to write some usage examples. There is a lot that is still missing. If someone else has the time to contribute an example, please do.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ahjohannessen
Copy link
Contributor

Great stuff @fdietze 👍

@cornerman cornerman added this to the 1.0 milestone Nov 26, 2018
@cornerman
Copy link
Member

I am in favor of merging this even if it is not finished. The new readme with examples already is an improvement and we can fill the gaps later.

@cornerman
Copy link
Member

I think, we need to update some source code references after merging the prs.

README.md Outdated Show resolved Hide resolved
Copy link
Member

@LukaJCB LukaJCB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it! I left a couple of comments :)
I'm not really sure if all of this should be in the Readme, but I can't think of anything better right now 😄

@fdietze fdietze merged commit 87d2e80 into master Dec 31, 2018
@fdietze fdietze deleted the tut branch December 31, 2018 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants