Skip to content

Commit

Permalink
Merge pull request #362 from qlrd/docs-installer-v0.0.13-update
Browse files Browse the repository at this point in the history
Docs installer v0.0.13 update II
  • Loading branch information
odudex authored Apr 12, 2024
2 parents 5ce6aae + 044ca24 commit 290f071
Show file tree
Hide file tree
Showing 20 changed files with 108 additions and 242 deletions.
324 changes: 96 additions & 228 deletions docs/getting-started/installing/from-gui.en.md

Large diffs are not rendered by default.

8 changes: 3 additions & 5 deletions docs/getting-started/installing/from-pre-built-release.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,6 @@ ls /dev/cu.usbserial*
```
Different OS versions may have different port names, and the absence of ports may indicate a connection, driver or hardware related issue.

### Multilingual support
Prefer a different language? Krux has support for multiple languages. Once at the start screen, go to `Settings`, followed by `Locale`, and select the locale you wish to use.

### Upgrade via microSD card
Once you've installed the initial firmware on your device via USB, you can either continue updating the device by flashing or you can perform upgrades [via microSD](../features/sd-card-update.md) card to keep the device airgapped.
----8<----
tips-after-install.md
----8<----
11 changes: 3 additions & 8 deletions docs/getting-started/installing/from-source.en.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This page explains how to install Krux from source.
This page explains how to install Krux from source. You can check these instructions in our [README](https://github.com/selfcustody/krux) too.

#### Software
You will need a computer with [`git`](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [`vagrant`](https://www.vagrantup.com/downloads) installed.
Expand Down Expand Up @@ -78,13 +78,8 @@ flash-krux-logo.md
amigo-more-info-faq.md
----8<----

### Multilingual support
Prefer a different language? Krux has support for multiple languages. Once at the start screen, go to `Settings`, followed by `Locale`, and select the locale you wish to use.

### Upgrade via microSD card
Once you've installed the initial firmware on your device via USB, you can either continue updating the device by flashing or you can perform upgrades [via microSD](../features/sd-card-update.md) card to keep the device airgapped.
After you've built the firmware, you can sign it using one of the following methods:
### Signing the firmware
You can sign the firmware using one of the two methods listed below:

#### Method 1: Signing from Krux
First, calculate the SHA256 hash of the new firmware by running:
Expand Down
Binary file removed docs/img/krux-installer/download_release.png
Binary file not shown.
Binary file removed docs/img/krux-installer/flash_done.png
Binary file not shown.
Binary file removed docs/img/krux-installer/flash_finished.png
Binary file not shown.
Binary file removed docs/img/krux-installer/flash_run.png
Binary file not shown.
Binary file removed docs/img/krux-installer/flash_start.png
Binary file not shown.
Binary file removed docs/img/krux-installer/github_retrieve.png
Binary file not shown.
Binary file modified docs/img/krux-installer/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/krux-installer/main2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/krux-installer/select_device.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/krux-installer/select_flash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/krux-installer/select_version_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/krux-installer/windows_warn0.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/krux-installer/wipe_finished.png
Binary file not shown.
Binary file removed docs/img/krux-installer/wipe_run.png
Binary file not shown.
Binary file modified docs/img/krux-installer/wipe_warn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/snippets/flash-krux-logo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ When the flashing process completes, you should see the Krux logo:
<img src="../../../img/maixpy_amigo/logo-150.png">
<img src="../../../img/maixpy_m5stickv/logo-125.png">

If after 30 seconds you still see a black screen, try power cycling the device by holding down the power button for six seconds.
If it doesn't, try turning your device off and on by holding down the power button for six seconds.

Congrats, you're now running Krux!
5 changes: 5 additions & 0 deletions docs/snippets/tips-after-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Multilingual support
Prefer a different language? Krux has support for multiple languages. Once at the start screen, go to `Settings`, followed by `Locale`, and select the locale you wish to use.

### Upgrade via microSD card
Once you've installed the initial firmware on your device via USB, you can either continue updating the device by flashing or you can perform upgrades [via microSD](../features/sd-card-update.md) card to keep the device airgapped.

0 comments on commit 290f071

Please sign in to comment.