Docs changes on install instructions

selfcustody · Feb 25, 2024 · 31c4e6c · 31c4e6c
1 parent 9b6b2da
commit 31c4e6c
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 69 deletions.
diff --git a/docs/getting-started/installing/from-gui.en.md b/docs/getting-started/installing/from-gui.en.md
@@ -108,3 +108,12 @@ If they are already present on your computer, the application will give you the
 Once we choose the device and firmware, we can flash. Before start the flash process itself, you be warned that you must plug and power on your device.
 
 ![flash-device](../../img/krux-installer/flash-device.gif "KruxInstaller Flash to device")
+
+##### A note about the Amigo
+Some Amigo screens have inverted X coordinates, others display colors differently. For more info check this FAQ item: ["Why are the buttons on my Amigo in the wrong order? Why is my Amigo screen displaying the wrong colors?"](../../../faq/#why-are-the-buttons-on-my-amigo-in-the-wrong-order-why-is-my-amigo-screen-displaying-the-wrong-colors)
+
+### 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.
diff --git a/docs/getting-started/installing/from-pre-built-release.en.md b/docs/getting-started/installing/from-pre-built-release.en.md
@@ -23,12 +23,12 @@ Extract the latest version of Krux you downloaded and enter the folder:
 unzip krux-vX.Y.Z.zip && cd krux-vX.Y.Z
 ```
 
-Connect the device to your computer via USB (for Amigo, make sure you’re using bottom port), power it on, and run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `amigo_ips`, or `bit`:
+Connect the device to your computer via USB (for Amigo, make sure you’re using bottom port), power it on, and run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `bit` or `yahboom` (to yahboom you may need to manually specify the port):
 ```bash
 ./ktool -B goE -b 1500000 maixpy_DEVICE/kboot.kfpkg
 ```
 
-For `dock` the `-b` parameter changes, so run:
+For `dock` the `-B` parameter changes, so run:
 ```bash
 ./ktool -B dan -b 1500000 maixpy_dock/kboot.kfpkg
 ```
@@ -69,12 +69,10 @@ 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.
 
 #### A note about the Amigo
-Some Amigo screens have inverted x coordinates while others don’t.
-
-If after flashing `maixpy_amigo_tft` to your device you notice that the buttons on keypad input screens appear to be in the wrong order, please try flashing `maixpy_amigo_ips` instead (or vice versa) which should correct the issue. 
+Some Amigo screens have inverted X coordinates, others display colors differently. For more info check this FAQ item: ["Why are the buttons on my Amigo in the wrong order? Why is my Amigo screen displaying the wrong colors?"](../../../faq/#why-are-the-buttons-on-my-amigo-in-the-wrong-order-why-is-my-amigo-screen-displaying-the-wrong-colors)
 
 ### 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. If you have a microSD card inserted into the device, your preference will be automatically saved to a `settings.json` file at the root of the card.
+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.
diff --git a/docs/getting-started/installing/from-source.en.md b/docs/getting-started/installing/from-source.en.md
@@ -40,7 +40,7 @@ The first command will create `privkey.pem` and `pubkey.pem` files you can use w
 Once you've updated the `SIGNER_PUBKEY` with this value, you can proceed with the regular build process.
 
 #### Build
-Run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `amigo_ips`, `dock`, or `bit`:
+Run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `dock`, `bit` or `yahboom`:
 ```bash
 vagrant ssh -c 'cd /vagrant; ./krux build maixpy_DEVICE'
 ```
@@ -50,7 +50,7 @@ This will take around an hour or so to complete the first time. Subsequent build
 If all goes well, you should see a new `build` folder containing `firmware.bin` and `kboot.kfpkg` files when the build completes.
 
 ### Flash the firmware onto the device
-Connect the device to your computer via USB (for Amigo, make sure you’re using bottom port), power it on, and run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `amigo_ips`, `dock`, or `bit`:
+Connect the device to your computer via USB (for Amigo, make sure you’re using bottom port), power it on, and run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `dock`, `bit` or `yahboom`:
 ```bash
 vagrant ssh -c 'cd /vagrant; ./krux flash maixpy_DEVICE'
 ```
@@ -73,17 +73,15 @@ If after 30 seconds you still see a black screen, try power cycling the device b
 Congrats, you're now running Krux!
 
 #### A note about the Amigo
-Some Amigo screens have inverted x coordinates while others don’t.
-
-If after flashing `maixpy_amigo_tft` to your device you notice that the buttons on keypad input screens appear to be in the wrong order, please try flashing `maixpy_amigo_ips` instead (or vice versa) which should correct the issue. 
+Some Amigo screens have inverted X coordinates, others display colors differently. For more info check this FAQ item: ["Why are the buttons on my Amigo in the wrong order? Why is my Amigo screen displaying the wrong colors?"](../../../faq/#why-are-the-buttons-on-my-amigo-in-the-wrong-order-why-is-my-amigo-screen-displaying-the-wrong-colors)
 
 ### 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. If you have a microSD card inserted into the device, your preference will be automatically saved to a `settings.json` file at the root of the card.
+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 card to keep the device airgapped.
+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.
+After you've built the firmware, you can sign it using one of the following methods:
 
 #### Method 1: Signing from Krux
 First, calculate the SHA256 hash of the new firmware by running:
@@ -109,8 +107,3 @@ vagrant ssh -c 'cd /vagrant; ./krux sign build/firmware.bin privkey.pem'
 ```
 
 This will generate a `firmware.bin.sig` file containing a signature of the firmware's SHA256 hash.
-
-### Upgrade via microSD card (continued)
-To perform an upgrade, simply copy the `firmware.bin` and `firmware.bin.sig` files to the root of a FAT-32 formatted microSD card, insert the card into your device, and reboot the device. If it detects the new firmware file and is able to verify the signature, you will be prompted to install it.
-
-Once installation is complete, eject the microSD card and delete the firmware files before reinserting and rebooting.
diff --git a/docs/getting-started/installing/from-test-release.en.md b/docs/getting-started/installing/from-test-release.en.md
@@ -1,111 +1,69 @@
-This page explains how to install Krux from a test, pre-built release.
+This page explains how to install Krux from a test (beta), pre-built release.
 
 ### Warning
-
-Keep in mind that these are unsigned binaries
+Keep in mind that these are unsigned binaries.
 
 ### Download
-Download experimental compiled firmware or Android app: [Krux binaries](https://github.com/odudex/krux_binaries)
+Download experimental compiled firmware or the Android app `apk`: [Krux binaries](https://github.com/odudex/krux_binaries)
 
 #### Android
-
-Krux Android app is intended for learning about Krux and Bitcoin air-gapped transactions. Vulnerabilities inherent in Android phones such as the OS, other apps and wireless connectivity make using any phone insecure. Krux app should NOT be used to manage savings or important keys and mnemonics. For that, a dedicated device is recommended.
+Krux Android app is intended for learning about Krux and Bitcoin airgapped transactions. Vulnerabilities inherent to Android phones such as the OS, other apps and wireless / CDMA / GSM / Bluetooth connectivity make using any phone insecure. Krux app should NOT be used to manage savings or important keys and mnemonics. For that, a dedicated device is recommended.
 
 #### M5StickV
-
 ##### Linux
-
 To Flash M5stickV run:
-
 ```bash
 ./ktool-linux -B goE -b 1500000 maixpy_m5stickv/kboot.kfpkg
 ```
 
 ##### Windows
-
 Replace './ktool-linux' for 'ktool-win.exe' and / for \ in commands. Ex:
-
 ```pwsh
 ./ktool-win.exe -B goE -b 1500000 maixpy_m5stickv\kboot.kfpkg
 ```
 
 #### Sipeed Amigo TFT
-
 ##### Linux
 To Flash Maix Amigo run:
-
 ```bash
 ./ktool-linux -B goE -b 1500000 maixpy_amigo_tft/kboot.kfpkg
 ```
 
 ##### Windows
-
-Replace './ktool-linux' for 'ktool-win.exe' and / for \ in commands. Ex:
-
-```pwsh
-./ktool-win.exe -B goE -b 1500000 maixpy_amigo_ips\kboot.kfpkg
-```
-
-#### Sipeed Amigo IPS
-
-##### Linux
-
-If your Amigo got flipped character position on keypads and switched Yes/No questions try the IPS version:
-
-```bash
-./ktool-linux -B goE -b 1500000 maixpy_amigo_ips/kboot.kfpkg
-```
-
-##### Windows
-
 Replace './ktool-linux' for 'ktool-win.exe' and / for \ in commands. Ex:
-
 ```pwsh
 ./ktool-win.exe -B goE -b 1500000 maixpy_amigo_tft\kboot.kfpkg
 ```
 
 #### Sipeed Bit
-
 ##### Linux
-
 To Flash Maix Dock run:
-
 ```bash
 ./ktool-linux -B goE -b 1500000 maixpy_bit/kboot.kfpkg
 ```
 
 ##### Windows
-
 Replace './ktool-linux' for 'ktool-win.exe' and / for \ in commands. Ex:
-
 ```pwsh
 ./ktool-win.exe -B goE -b 1500000 maixpy_bit\kboot.kfpkg
 ```
 
 #### Sipeed Dock
-
 ##### Linux
-
 To Flash Maix Dock run:
-
 ```bash
-./ktool-linux -B goE -b 1500000 maixpy_dock/kboot.kfpkg
+./ktool-linux -B dan -b 1500000 maixpy_dock/kboot.kfpkg
 ```
 
 ##### Windows
-
 Replace './ktool-linux' for 'ktool-win.exe' and / for \ in commands. Ex:
-
 ```pwsh
-./ktool-win.exe -B goE -b 1500000 maixpy_dock\kboot.kfpkg
+./ktool-win.exe -B dan -b 1500000 maixpy_dock\kboot.kfpkg
 ```
 
-#### Aimotion Yahboom
-
+#### Aimotion Yahboom k210 module
 ##### Linux
-
-To Flash Yahboom Aimotion you'll have to manually specify the port, on this example /dev/ttyUSB0:
-
+To Flash Yahboom k210 module you'll have to manually specify the port, on this example `/dev/ttyUSB0`:
 ```bash
 ./ktool-linux -B goE -b 1500000 -p /dev/ttyUSB0 yahboom/kboot.kfpkg
 ```