Added documentation to the readme for quick start #189
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shawaj
approved these changes
Oct 29, 2021
vpetersson
pushed a commit
that referenced
this pull request
Nov 15, 2021
…and pktfwd rewrite (#215) * test diag with new base image test diag with new base image * bump upnp for testing bump upnp for testing * fix: add depends on for packet forwarder The packet forwarder actually requires the miner container to be able to accept connections on the hostname helium-miner before it will be able to start the concentrator. This adds a depends_on to not attempt to start the packet forwarder container until the miner container is up * Create docker-compose.yml Bumps UPnP, config, diag and packet forwarder containers so they are now all using the same base image. We need to now test that it's actually smaller so will leave #182 open for now. * Bump to 2021.10.27.0_GA Bump to 2021.10.27.0_GA * Added documentation to the readme for quick start (#189) Added documentation to the readme for quick start (#189) * Bump to 2021.10.29.0_GA Bump to 2021.10.29.0_GA * Bump to 2021.11.02.0_GA Bump to 2021.11.02.0_GA * rearrange readme rearrange readme * Update README.md * Bump diag and config Bump diag and config * feat: bump GA to 2021.11.04.2 * release: bump GA to 2021.11.10.0 * release: bump GA to 2021.11.11.0 * Add tech support to CODEOWNERS Partially fixes #208 * fix: ECC locking and initFile (#209) Lock ECC usage and ensure initFile always returns. * build: bump firmware version * bump(pktfwd): current master branch Including likely unnecessary patch to regions. Co-authored-by: Aaron Shaw <shawaj@gmail.com> Co-authored-by: Sebastian Maj <WolfTech@cogeco.ca>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
While going through the document I felt like the steps provided helped me a lot with getting my raspberry pi setup with Balena and pushing code using the fleet system. I thought it would make a great addition to the documentation.
How
I included a little quick start guide with information on prerequisites and steps to help guide you through the process from start to finish of setting up your raspberry pi as a development environment for the repository and the modules included with it. I also included the useful Balena quick start guide with the step-by-step process of getting your first fleet up and running using the raspberry pi.