search

huww98 / TimeChart

An chart library specialized for large-scale time-series data, built on WebGL.
https://huww98.github.io/TimeChart
MIT License
365 stars 31 forks source link

no code examples/tutorials on the README #28

Open jumper385 opened 3 years ago

jumper385 commented 3 years ago

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 commented 3 years ago

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?