diff --git a/README.md b/README.md index d37610cf..99697aee 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/selfcustody/krux/blob/main/LICENSE.md)

- - - - - - +maixpy amigo device +m5stickv device +maixpy dock device +yahboom device +maixpy cube device +wonder mv device

Krux is an open-source firmware facilitating the creation of Bitcoin signing devices from readily available components, such as Kendryte K210 devices. It transforms these devices into airgapped tools capable of handling transactions for both single and multisignature wallets, supporting offline signing via QR code or SD card, thus empowering users to securely self-custody their Bitcoin. @@ -25,10 +25,14 @@ Krux is an open-source firmware facilitating the creation of Bitcoin signing dev --- # Getting Started -Detailed instructions for installing and running Krux can now be found in our [official documentation](https://selfcustody.github.io/krux/) +Detailed instructions for installing and running Krux can now be found in our [official documentation](https://selfcustody.github.io/krux/). + The instructions below are intended for programmers or developers who want to contribute to the project. +## Download our firmware releases +[github releases page](https://github.com/selfcustody/krux/releases) + # Development ## Fetch the code This will download the source code of Krux as well as the code of all its dependencies inside a new folder called `krux`: diff --git a/docs/getting-started/features/tamper-detection.en.md b/docs/getting-started/features/tamper-detection.en.md index 469c2553..afe4e708 100644 --- a/docs/getting-started/features/tamper-detection.en.md +++ b/docs/getting-started/features/tamper-detection.en.md @@ -50,7 +50,7 @@ The *TC Flash Hash* tool enables you to verify if the device's internal flash me - **User's Region:** The area used to stored encrypted mnemonics, settings and TC Code. It generates the last set of two words.
- TC Flash Hash + TC Flash Hash
*Example: The blue symbol and words 'tail monkey' represent the firmware region, while 'wrestle over' user's region.* diff --git a/docs/getting-started/index.en.md b/docs/getting-started/index.en.md index 496bf27f..bd5c7305 100644 --- a/docs/getting-started/index.en.md +++ b/docs/getting-started/index.en.md @@ -1,4 +1,4 @@ - + Krux is open-source Bitcoin signing firmware for devices with the K210 chipset; also known as a hardware signer. diff --git a/docs/getting-started/installing/from-gui/index.en.md b/docs/getting-started/installing/from-gui/index.en.md index 3ffa1474..33866274 100644 --- a/docs/getting-started/installing/from-gui/index.en.md +++ b/docs/getting-started/installing/from-gui/index.en.md @@ -1,10 +1,9 @@ You can install Krux (both official or beta releases) onto your K210-based device using our -official desktop application, [KruxInstaller](https://github.com/selfcustody/krux-installer), -available for: +official desktop application, **KruxInstaller**: -> ⚠️ WARNING: Krux-Installer latest version is in it's alpha version. Maybe you can experience -> bugs or don't like something. If it is the case, please submit a -[issue](https://github.com/selfcustody/krux-installer/issues). +[](https://github.com/selfcustody/krux-installer/releases) + +Install instructions: - [:material-microsoft-windows: Windows](./windows.en.md) - [:material-apple: MacOS Intel](./macos-intel.en.md) @@ -13,3 +12,5 @@ available for: - [:material-fedora: Fedora and like](./fedora-like.en.md) - [:material-linux: Other linux distros](./other-linux-distro.en.md) +> ⚠️ WARNING: Krux-Installer is currently in alpha. If you find any bug, please submit a +[issue here](https://github.com/selfcustody/krux-installer/issues). \ No newline at end of file diff --git a/docs/getting-started/installing/from-pre-built-release.en.md b/docs/getting-started/installing/from-pre-built-release.en.md index 2ff00025..a447903e 100644 --- a/docs/getting-started/installing/from-pre-built-release.en.md +++ b/docs/getting-started/installing/from-pre-built-release.en.md @@ -1,7 +1,6 @@ -This page explains how to install Krux from an official, pre-built release. +This page explains how to download and install Krux firmware from our official, pre-built latest release. -### Download the latest release -Head over to the [releases](https://github.com/selfcustody/krux/releases) page and download the latest signed release. +[](https://github.com/selfcustody/krux/releases) ### Verify the files Before installing the release, it's a good idea to check that: diff --git a/docs/img/badge_github.png b/docs/img/badge_github.png new file mode 100644 index 00000000..326d2547 Binary files /dev/null and b/docs/img/badge_github.png differ diff --git a/docs/img/flash_hash.bmp b/docs/img/flash_hash.bmp deleted file mode 100644 index 65db41b3..00000000 Binary files a/docs/img/flash_hash.bmp and /dev/null differ diff --git a/docs/img/flash_hash.png b/docs/img/flash_hash.png new file mode 100644 index 00000000..24f2bd8b Binary files /dev/null and b/docs/img/flash_hash.png differ diff --git a/docs/parts.en.md b/docs/parts.en.md index df4229d4..ea5ba3bf 100644 --- a/docs/parts.en.md +++ b/docs/parts.en.md @@ -1,7 +1,6 @@ -## Krux Compatible Devices - + -### Comparative Table +### Compatible Devices (comparative table) | Device | M5StickV | Maix Amigo | Maix Dock | Maix Bit | Yahboom k210 module | Maix Cube | WonderMV | | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |