Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme and docs get it on GitHub #497

Merged
merged 6 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/selfcustody/krux/blob/main/LICENSE.md)

<p align="center">
<img src="https://selfcustody.github.io/krux/img/maixpy_amigo/logo-150.png">
<img src="https://selfcustody.github.io/krux/img/maixpy_m5stickv/logo-125.png" width="75">
<img src="https://selfcustody.github.io/krux/img/maixpy_dock/logo-151.png" width="144">
<img src="https://selfcustody.github.io/krux/img/maixpy_yahboom/logo-156.png" width="116">
<img src="https://selfcustody.github.io/krux/img/maixpy_cube/logo-200.png" width="120">
<img src="https://selfcustody.github.io/krux/img/maixpy_wonder_mv/logo-152.png" width="116">
<img src="docs/img/maixpy_amigo/logo-150.en.png" alt="maixpy amigo device">
<img src="docs/img/maixpy_m5stickv/logo-125.en.png" alt="m5stickv device" width="75">
<img src="docs/img/maixpy_dock/logo-151.en.png" alt="maixpy dock device" width="144">
<img src="docs/img/maixpy_yahboom/logo-156.en.png" alt="yahboom device" width="116">
<img src="docs/img/maixpy_cube/logo-200.en.png" alt="maixpy cube device" width="120">
<img src="docs/img/maixpy_wonder_mv/logo-152.en.png" alt="wonder mv device" width="116">
</p>

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.
Expand All @@ -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
[<img src="docs/img/badge_github.png" alt="github releases page" width="186">](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`:
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/features/tamper-detection.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,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.

<div style="text-align: center;">
<img src="../../../img/flash_hash.bmp" alt="TC Flash Hash" width="200"/>
<img src="../../../img/flash_hash.png" alt="TC Flash Hash" width="200"/>
</div>

*Example: The blue symbol and words 'tail monkey' represent the firmware region, while 'wrestle over' user's region.*
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/index.en.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="../img/krux-devices.jpg">
<img src="../img/krux-devices.jpg" width="800">

Krux is open-source Bitcoin signing firmware for devices with the K210 chipset; also known as a hardware signer.

Expand Down
11 changes: 6 additions & 5 deletions docs/getting-started/installing/from-gui/index.en.md
Original file line number Diff line number Diff line change
@@ -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).
[<img src="../../../img/badge_github.png" width="186">](https://github.com/selfcustody/krux-installer/releases)

Install instructions:

- [:material-microsoft-windows: Windows](./windows.en.md)
- [:material-apple: MacOS Intel](./macos-intel.en.md)
Expand All @@ -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).
5 changes: 2 additions & 3 deletions docs/getting-started/installing/from-pre-built-release.en.md
Original file line number Diff line number Diff line change
@@ -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.
[<img src="../../../img/badge_github.png" width="186">](https://github.com/selfcustody/krux/releases)

### Verify the files
Before installing the release, it's a good idea to check that:
Expand Down
Binary file added docs/img/badge_github.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 removed docs/img/flash_hash.bmp
Binary file not shown.
Binary file added docs/img/flash_hash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 2 additions & 3 deletions docs/parts.en.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
## Krux Compatible Devices
<img src="../img/krux-devices.jpg">
<img src="../img/krux-devices.jpg" width="600">

### Comparative Table
### Compatible Devices (comparative table)

| Device | M5StickV | Maix Amigo | Maix Dock | Maix Bit | Yahboom k210 module | Maix Cube | WonderMV |
| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
Expand Down
Loading