search

ChartsOrg / Charts

Beautiful charts for iOS/tvOS/OSX! The Apple side of the crossplatform MPAndroidChart.
Apache License 2.0
27.58k stars 6k forks source link

Create documentation #4386

Open juanjoseluisgarcia opened 4 years ago

juanjoseluisgarcia commented 4 years ago

This project has evolved enough to deserve its own documentation. There is no documentation to do many things that are advertised like combined charts etc. Also, there are readonly properties that are not in the Android project this library was inspired on. This project needs documentation.

liuxuan30 commented 4 years ago

well... I would agree, but the reality is we don't have the man power right now. It already takes most of my free time on github for just reviewing PRs and looking at the issues.

We would be very glad if someone could help on this.

I tried to create jazzy to add a docset for this library a long time ago, but at that time, jazzy is not perfect to generate docset for this library. I didn't try since then, but it's a good time to revisit it now. Anyone mind to take a look?

But it's ok to look at android documentations and ask on stack overflow. We also have a Tutorials section on README.md where many contributors add their tutorials how to use the library.

Another good way is to play with ChartsDemo, you will find most of the feature there.