Skip to content

Commit

Permalink
Merge pull request selfcustody#241 from selfcustody/main
Browse files Browse the repository at this point in the history
Docs review
  • Loading branch information
odudex authored Sep 15, 2023
2 parents 4d1c9b4 + 1863ed3 commit 99f21fa
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<p align="center">
<img src="https://selfcustody.github.io/krux/img/maixpy_m5stickv/logo-125.png">
<img src="https://selfcustody.github.io/krux/img/maixpy_amigo_tft/logo-125.png">
<img src="https://selfcustody.github.io/krux/img/maixpy_amigo_tft/logo-150.png">
</p>

Krux is open-source firmware that enables anyone to build their own Bitcoin signing device via off-the-shelf parts. It runs on Kendryte K210 devices such as the [M5StickV](https://docs.m5stack.com/en/core/m5stickv) and [Maix Amigo](https://www.seeedstudio.com/Sipeed-Maix-Amigo-p-4689.html), converting them into airgapped devices that can sign transactions for multisignature and single-sig wallets.
Expand Down
6 changes: 5 additions & 1 deletion docs/faq.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ Additionally, Krux recognizes animated QR codes that use either the plaintext `p
## 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. In the future, more work will be done to support displaying lower density QR codes. For now, a workaround you can do is to take a picture or video of the QR code with a better-quality camera (such as your phone), then enlarge and display the photo or video to your webcam. Alternatively, it may be simpler to use a mobile wallet such as BlueWallet with the M5StickV since phone cameras don't seem to have issues reading the small QR codes.

## Why isn't my Amigo device being recognized?
Make sure you’re using the bottom USB-C port, not the one on the left side.

## Why won't my (Linux) OS list a serial port after connecting my device?
If you get the following error when trying to flash your device: `Failed to find device via USB. Is it connected and powered on?`
Make sure your device is being detected and serial ports are being mounted by running:
Expand All @@ -59,7 +62,8 @@ If you don't see them, your OS may not be loading the correct drivers to create
sudo apt-get remove brltty
```

If you are using an Amigo, make sure you’re using bottom USB-C port, not the one on the left side.
## Why won't my (Apple) OS list a serial port after connecting my device?
Some users reported that they were able to make their Apple devices recognize Krux devices only after they connected them through an USB dock instead of connecting them directly.

## Why are the buttons on my Amigo in the wrong order?
Some Amigo screens have inverted x coordinates while others don’t.
Expand Down
9 changes: 0 additions & 9 deletions docs/getting-started/installing/from-source.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,6 @@ If the flashing fails try one of the following common solutions:
sudo usermod -a -G vboxusers yourusername
```
- If the flashing process fails midway through, check the connection, restart the device, and try the command again.
- If it continues to fail midway through, you can try using an alternative method of flashing with `kflash` if you're using a Linux machine. To install klash:
```bash
pip3 install kflash
```
Then you can flash the device:
```bash
kflash -p /dev/ttyUSB1 -b 1500000 -B goE build/firmware.bin
```
If you get a `Greeting fail, check serial port` error, try replacing `/dev/ttyUSB1` with `/dev/ttyUSB0` in the `kflash` command above.

When the flashing process completes, you should see the Krux logo:

Expand Down

0 comments on commit 99f21fa

Please sign in to comment.