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

no code examples/tutorials on the README #28

Open
jumper385 opened this issue Jul 14, 2021 · 1 comment
Open

no code examples/tutorials on the README #28

jumper385 opened this issue Jul 14, 2021 · 1 comment

Comments

@jumper385
Copy link
Contributor

there needs to be code examples on the README.

should i write up code samples? This stems from the demo code for disposing of the charts - it only shows disposal but it doesn't properly show how to reload it and update it.

can i set up some tutorial pages and make that a 'chapter' on the README?

@huww98
Copy link
Owner

huww98 commented Jul 14, 2021

I would only add small code snippets in markdown. I prefer to add code examples to https://github.com/huww98/TimeChart/tree/master/demo, then add links from markdown, so that readers can actually see how it works (e.g. https://huww98.github.io/TimeChart/demo/reset.html for disposing and re-creating the chart).

Tutorial is good. But writing it is not easy, Maybe we should work out an outline first?

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

No branches or pull requests

2 participants