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

Getting started link in Readme is dead / need better instructions on how to download and install the firmware examples #7

Open
sysfu opened this issue Sep 13, 2023 · 1 comment

Comments

@sysfu
Copy link

sysfu commented Sep 13, 2023

I think this is the current getting started link: https://docs.helium.com/network-iot/devices/development/heltec/cubecell-dev-board/platformio The information at this link appears to be outdated as well because it make reference to Manual updates to the Heltec runtime libraries which now appear to be unnecessary.

There also needs to be better instructions about how to download or install the two firmware examples. With Arduino it's pretty straightforward, download the sketch file and open it up. With Platform.io it's a bit more obtuse and involves copying and pasting the longfi firmware examples into the projects src/main.cpp file. Newbs will also be confused because they don't know if all the other files included in the repository are necessary, or what to do with them, how to install them in VS Codes Platform.io extension, etc.

@sysfu sysfu changed the title Getting started link in Readme is dead Getting started link in Readme is dead / need better instructions on how to download and install the firmware examples Sep 13, 2023
@slivingston
Copy link
Contributor

@sysfu Thanks for catching the broken link and for feedback about clarity. I will open PRs accordingly.

slivingston added a commit to slivingston/longfi-platformio that referenced this issue Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants