Add hint how to checkout v2.x of GxEPD

sqfmi / badgy

Home of Badgy - IoT Badge

http://badgy.sqfmi.com

MIT License

311 stars 61 forks source link

Add hint how to checkout v2.x of GxEPD #25

Closed roschaefer closed 6 years ago

roschaefer commented 6 years ago

I couldn't find this library via Sketch > Include Libraries > Manage Libraries and didn't know how to pin the version to 2.x (the respective repository does not have tags). I thought these instruction could make life a little easier for beginners like me :baby:

JPRuskin commented 6 years ago

Two possible things:

Do you need to change directory into the cloned repository before running git checkout? I'm running on Windows, so it may be different.
This may be fixed in #24, or covered (arguable - yours is a better method to explain it) in #23.

Additionally, I think your suggestion to add tags or releases or... well, anything to the GxEPD library has a lot of merit, and I am surprised at the reaction. (speaking as someone else who was bitten by this over the last few days ;))

roschaefer commented 6 years ago

You are correct! I forgot to mention that you have to place the repository in the libraries folder of Arduino IDE and cd in there. However, updating to version 3.0 here seems to be the best solution, I guess.

roschaefer commented 6 years ago

I will close this PR. #23 and #24 have been opened prior to this, so next time I will check out if sb. already send a PR. If you ask me, merge #23 then remove the changes in #24 and merge that PR. This is the best solution in my opinion.