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

Update readme for first-timers to avoid confusion #34

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,6 @@ For those wanting to override the looks of this Watchy face, look at the Overrid

V3: For those with the 2024 V3 Watchy, see the file in the main folder about it.

To get this setup for compiling, you need to make a folder in your (Arduino) Stream folder or (PlatformIO) project folder, call it GSR, in there, download the "Starting Point.zip" and latest Release (Source Code) .zip from the Release folder above.
Extract both "Starting Point.zip" and the latest release (Source Code .zip) into the GSR folder, this will ensure all the necessary files are there. If you plan to download any AddOns, be sure to deposit those files into the same GSR folder. Follow the instructions for including AddOns in the src folder's Compilation Instructions.
To get this ready for compiling, you'll need to make a folder in your (Arduino) Stream folder or (PlatformIO) project folder, call it GSR. Download the latest Release Source code (zip) from the Release folder. Extract the contents of the src folder into the GSR folder. You'll also need to add manually several additional libraries from neighbouring repos: StableBMA, SmallNTP and Olson2POSIX. If working with Arduino IDE this can be done via Sketch -> Include Library -> Add .ZIP Library...

If you plan to download any AddOns, be sure to deposit those files into the same GSR folder. Follow the instructions for including AddOns in the src folder's Compilation Instructions.