Skip to content

Commit

Permalink
Added get it on github to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tadeubas committed Dec 14, 2024
1 parent f8ecee4 commit 1cfa23c
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 13 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Detailed instructions for installing and running Krux can now be found in our [o
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" height="70">](https://github.com/selfcustody/krux/releases)
[<img src="docs/img/badge_github.png" width="186">](https://github.com/selfcustody/krux/releases)

# Development
## Fetch the code
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
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

0 comments on commit 1cfa23c

Please sign in to comment.