Skip to content

Commit

Permalink
Merge pull request #346 from tadeubas/docs-update
Browse files Browse the repository at this point in the history
Change bitcointalk link to official release post
  • Loading branch information
odudex committed Apr 1, 2024
2 parents 4f68346 + 8145c00 commit 5ee2f7d
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 13 deletions.
8 changes: 4 additions & 4 deletions docs/faq.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ sudo apt-get remove brltty
## My device didn't reboot after flashing the firmware and when I turned it off and on again, it just stayed blank without showing anything on the screen. What should I do?
Check if the downloaded file matches the device, this can also occur due to data corruption. Try downloading binaries again. You can install [MaixPy IDE](https://dl.sipeed.com/shareURL/MAIX/MaixPy/ide/v0.2.5) to help with debugging, Tools > Open Terminal > New Terminal > Connect to serial port > Select a COM port available (if it doesn't work, try another COM port). It will show the terminal and some messages, a message about an empty device or with corrupted firmware appears like: "interesting, something's wrong, boot failed with exit code 233, go to find your vendor."

## What are all the features available? What are the additional features of the Test (Beta) version? Is there an Android app?
For [official releases](https://github.com/selfcustody/krux/releases) you will find all the features detailed here on the [Getting Started page](getting-started/index.md) with a brief summary on the [Navigation Overview page](getting-started/navigation.md). The latest and most experimental features, which we sometimes share on our social media, can be found only in the [test (beta) repository](https://github.com/odudex/krux_binaries/). Only official releases are signed, Test (Beta) is just for trying new things and providing feedback. Krux Android app is available as an `apk` on the [test (beta) repository](https://github.com/odudex/krux_binaries/) (requires Android 6.0 or above).
## What are all the features available? What are the additional features of the Test or Beta version? Is there an Android app?
For [official releases](https://github.com/selfcustody/krux/releases) you will find all the features detailed here on the [Getting Started page](getting-started/index.md) with a brief summary on the [Navigation Overview page](getting-started/navigation.md). The latest and most experimental features, which we sometimes share on our social media, can be found only in the [test (beta) repository](https://github.com/odudex/krux_binaries/). Only official releases are signed, Test or Beta is just for trying new things and providing feedback. Krux Android app is available as an `apk` on the [test (beta) repository](https://github.com/odudex/krux_binaries/) (requires Android 6.0 or above).

## Why does Krux show an xpub for a segwit address?
The xpub that Krux displays follows the [bitcoin core descriptors spec](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md/#key-origin-identification) and includes key origin and derivation info that, in theory, makes zpubs (and ypubs) unnecessary *if the wallet software being shown this extra information can parse it*.
Expand Down Expand Up @@ -85,13 +85,13 @@ For Wallet output descriptor:
2. Key-value INI files with at least `Format`, `Policy`, and `Derivation` keys
3. [UR Type `crypto-output`](https://github.com/BlockchainCommons/Research/blob/master/papers/bcr-2020-010-output-desc.md)

For Partially Signed Bitcoin Transactions (PSBT):
For PSBT (Partially Signed Bitcoin Transactions):

1. Base43, Base58, and Base64-encoded bytes
2. Raw Bytes
3. [UR Type `crypto-psbt`](https://github.com/BlockchainCommons/Research/blob/master/papers/bcr-2020-006-urtypes.md)

Additionally, Krux recognizes animated QR codes that use either the plaintext `pMofN` (Specter QR format) or binary [`UR`](https://github.com/BlockchainCommons/Research/blob/master/papers/bcr-2020-005-ur.md) encodings.
Additionally, Krux recognizes animated QR codes that use either the plaintext `pMofN` (the Specter QR format) or binary [`UR`](https://github.com/BlockchainCommons/Research/blob/master/papers/bcr-2020-005-ur.md) encodings.

## Why can't my computer read the QR code that Krux displays?
If you are using an M5StickV, the small screen makes it difficult for laptop webcams to capture enough detail to parse the QR codes it displays.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/features/sd-card-update.en.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### 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 via USB or you can perform upgrades via microSD card to keep the device airgapped.

To perform an upgrade, simply copy the [official release](https://github.com/selfcustody/krux/releases) `firmware.bin` and `firmware.bin.sig` files to the root of a FAT-32 (MBR) 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.
To perform an upgrade, simply copy the [official release](https://github.com/selfcustody/krux/releases) `firmware.bin` and `firmware.bin.sig` files to the root of a FAT-32 / MBR 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. Otherwise you will be prompted to install it again.

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/installing/from-gui.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This page explains how to install Krux with KruxInstaller (GUI).

You can install Krux onto your K210-based device using our official desktop application, which we named [KruxInstaller](https://github.com/selfcustody/krux-installer), available for Linux and Windows.

Under the hood the GUI uses the same methods described in [Installing from pre-build release](../installing/from-pre-built-release.md), i.e. download, verify and flash the latest official release, but you won't need to type any command. Additionally you will be able to install the [pre-built test (beta) release](../installing/from-test-release.md) too.
Under the hood the GUI uses the same methods described in [Installing from pre-build release](../installing/from-pre-built-release.md), i.e. download, verify and flash the latest official release, but you won't need to type any command. Additionally you will be able to install the [pre-built test or beta release](../installing/from-test-release.md) too.

Keep in mind that this is software under development in the alpha stage and may be buggy. If you find any bugs or want to contribute to the project, please open an [issue](https://github.com/selfcustody/krux-installer/issues) or make a PR.

Expand Down Expand Up @@ -67,7 +67,7 @@ This is the first step, to select the device we want to flash. Click on the drop
![select-device](../../img/krux-installer/select_device.gif "KruxInstaller Select Device Menu with choosen device")

#### Select version
Now select which firmware you want to flash, i.e. the [latest official release](https://github.com/selfcustody/krux/releases) or the [test (beta) release](https://github.com/odudex/krux_binaries). While in the official release we can [verify its integrity and authenticity](from-pre-built-release.md/#verify-the-files), in the second one we will have no means of verifying it, because it is not signed. However, the test (beta) firmware will contain the newest features that are being developed and discussed on our social media.
Now select which firmware you want to flash, i.e. the [latest official release](https://github.com/selfcustody/krux/releases) or the [test (beta) release](https://github.com/odudex/krux_binaries). While in the official release we can [verify its integrity and authenticity](from-pre-built-release.md/#verify-the-files), in the second one we will have no means of verifying it, because it is not signed. However, the test or beta firmware will contain the newest features that are being developed and discussed on our social media.

##### Official release
The software will display the latest officially released version in the form `selfcustody/tags/vXX.YY.Z`, where XX means the year of release, YY the month of release and Z a subversion of this release.
Expand All @@ -88,7 +88,7 @@ If they are already present on your computer, the application will give you the

![select-version-downloaded-selfcustody](../../img/krux-installer/select_version_downloaded_selfcustody.gif "KruxInstaller Select Selfcustody version downloaded Menu")

##### Test (beta) binaries
##### Test or beta binaries
As the name suggests, these binaries are intended for test purposes, contain experimental features, and are more likely to contain bugs. Use only for experimentation and to provide feedback.

The installer will present the latest test (beta) release.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/settings.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Here you choose between Thermal, CNC or none (default). Leave this setting to "n
#### Touchscreen (Maix Amigo and Yahboom only)
<img src="../../img/maixpy_amigo/touchscreen-150.png" align="right">

If your device has touchscreen you can change the touch detection threshold. If it is being too sensitive or detecting false (ghost) touches, you should increase the threshold value, making it less sensitive. The other way is also valid, reduce the threshold to make the screen more sensitive to touches.
If your device has touchscreen you can change the touch detection threshold. If it is being too sensitive or detecting false or ghost touches, you should increase the threshold value, making it less sensitive. The other way is also valid, reduce the threshold to make the screen more sensitive to touches.

<div style="clear: both"></div>

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/usage/generating-a-mnemonic.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ Don't trust, verify. We encourage you not to trust any claim you cannot verify

## Alternatives

You can use any other offline airgapped devices to generate your mnemonic. If you have an old Android smartphone that is offline (airplane mode [no active CDMA or GSM chip], no Wifi connection, no Bluetooth and localization service turned off), you can use the [Krux app for Android](../../faq.md#what-are-all-the-features-available-what-are-the-additional-features-of-the-test-beta-version-is-there-an-android-app). If you want to use a regular PC, a common strategy is to boot the PC using [Tails](https://tails.boum.org/) from a USB stick, without connecting the device to the internet, and then you can run Krux using our [simulator](https://github.com/selfcustody/krux?tab=readme-ov-file#run-the-simulator), use a copy of the the [Bitcoiner Guide website](https://bitcoiner.guide/seed/) or even [Ian Coleman's BIP-39 Tool](https://iancoleman.io/bip39/). It's worth noting that both generate a QR code that Krux can read via the QR input method mentioned on the next page (Loading a Mnemonic).
You can use any other offline airgapped devices to generate your mnemonic. If you have an old Android smartphone that is offline (in airplane mode [no active CDMA or GSM chip], no Wifi connection, no Bluetooth and localization service turned off), you can use the [Krux app for Android](../../faq.md#what-are-all-the-features-available-what-are-the-additional-features-of-the-test-beta-version-is-there-an-android-app). If you want to use a regular PC, a common strategy is to boot the PC using [Tails](https://tails.boum.org/) from a USB stick, without connecting the device to the internet, and then you can run Krux using our [simulator](https://github.com/selfcustody/krux?tab=readme-ov-file#run-the-simulator), use a copy of the the [Bitcoiner Guide website](https://bitcoiner.guide/seed/) or even [Ian Coleman's BIP-39 Tool](https://iancoleman.io/bip39/). It's worth noting that both generate a QR code that Krux can read via the QR input method mentioned on the next page (Loading a Mnemonic).
2 changes: 1 addition & 1 deletion docs/getting-started/usage/using-a-multisig-wallet.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Go to *Send* in Specter Desktop, fill in the recipient address, amount, and any

<img src="../../../img/specter/create-transaction-screen-600.png">

You will now see a screen listing the devices in your wallet. Select the device you want to sign the transaction (PSBT) with.
You will now see a screen listing the devices in your wallet. Select the device you want to sign the PSBT transaction with.

Specter Desktop will display an animated QR code of the PSBT that you can scan with Krux by going to *Sign > PSBT* in its main menu. After scanning, Krux should display info about the transaction for you to confirm before signing.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/usage/using-a-single-sig-wallet.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Go to *Send* in Specter Desktop, fill in the recipient address, amount, and any

<img src="../../../img/specter/create-transaction-screen-600.png">

You will now see a screen listing the devices in your wallet. Select the device you want to sign the transaction (PSBT) with.
You will now see a screen listing the devices in your wallet. Select the device you want to sign the PSBT transaction with.

Specter Desktop will display an animated QR code of the PSBT that you can scan with Krux by going to *Sign > PSBT* in its main menu. After scanning, Krux should display info about the transaction for you to confirm before signing.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ site_dir: public
extra:
social:
- icon: fontawesome/solid/bullhorn
link: https://bitcointalk.org/index.php?topic=5350905.0
link: https://bitcointalk.org/index.php?topic=5489022.0
name: Send a message to the Bitcoin Forum
- icon: fontawesome/brands/telegram
link: https://t.me/SC_Krux
Expand Down

0 comments on commit 5ee2f7d

Please sign in to comment.