Skip to content

Commit

Permalink
Merge pull request #2685 from reubenmiller/docs-rugpi-typos
Browse files Browse the repository at this point in the history
docs: fix typos and grammar on rugpi image build instructions
  • Loading branch information
reubenmiller authored Feb 6, 2024
2 parents 381f88e + 8704478 commit 05e32ab
Showing 1 changed file with 2 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,15 @@ For other installation possibilities check out the [just documentation](https://
```
:::tip
The Wifi credentials only need to be included in the image that is flashed to the SD card. Subsequent images don't need to included the Wifi credentials, as the network connection configuration files are persisted across images.
The Wifi credentials only need to be included in the image that is flashed to the SD card. Subsequent images don't need to include the Wifi credentials, as the network connection configuration files are persisted across images.

If an image has Wifi credentials baked in, then you should not make this image public, as it would expose your credentials!
:::




### Building an image

Building an image will produce a `.xz` file which can either by flashed to an SD card (or device). Afterwards your device will be enable to apply the same type of image via OTA updates.
Building an image will produce a `.xz` file which can be flashed to an SD card (or device). Afterwards your device will be able to apply the same type of image via OTA updates.

Images can be built in MacOS or Linux environments (including WSL 2), however if you have problems building the image, then you can build the images using the Github workflow after forking the project.

Expand Down

1 comment on commit 05e32ab

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
390 0 3 390 100 55m20.150999999s

Please sign in to comment.