I mean the ones you download on the fly or find online and install, they do usually come with example code, but my life would be a lot easier if instead I had a way to find the reference sheets for the libraries instead, I don't know how people usually find them, so I figured id ask because it wasn't in the tips or how too's....
Sometimes the included examples (File->Examples->libraryName->) are the only thing resembling documentation. Sometimes there are no examples.
Sometimes looking at the .h file helps. Find them in:
YourSketchbook->libraries->libraryName->libraryName.h
or
YourSketchbook->libraries->libraryName->src->libraryName.h
You can find your sketchbook folder location at the top of the Preferences... dialog.
Sometimes you can find documentation with a Google search for: libraryName.h arduino
The places I typically look to learn about a library’s functionality are (in order) the README on github, the example programs, the source code itself (.h and .cpp files). Reading at the source code is the most informative because it, by definition, describes exactly how the code works.
Before bemoaning the lack of official documentation, consider:
Many “libraries” start out simply as code that someone writes to get their project done. They then make it available for others on github. FOR FREE.
Writing code is a lot more fun than writing documentation.
Now, if you’re talking about a library supplied by a vendor to support their device, and you’ve purchased that device, then the bar should be a little higher.
thank you bob and john, that is exactly the information I needed!
I guess I will start looking on github for the libraries I have!
gfvalvo:
Before bemoaning the lack of official documentation, consider:
Bemoaning? I wasn't even complaining.... I did not know where to find documentation, now I know to look on github.... I am not complaining that they aren't documenting a library, I was pointing out that example code is nice, but I wanted to know the standard practice for finding more than that....I know that libraries are given for free online usually...