Merge pull request #13 from tadeubas/develop_rc

All QR Codes not allow brightness change

.github/codecov.yml

@@ -2,5 +2,5 @@ coverage:
   status:
     project:
       default:
-        target: 90%
-        threshold: 5%
+        target: 100%
+        threshold: 15%

.gitignore

@@ -79,7 +79,3 @@ simulator/sd
 !tests/firmware-v0.0.0.bin.badsig
 !tests/firmware-v0.0.0.bin.sha256.txt
 !tests/firmware-v0.0.0.bin.sig
-
-# Poetry automatically generated files
-######################
-poetry.lock

CHANGELOG.md

@@ -1,45 +1,45 @@
 # Version 23.08.0 - August, 2023
-After a long year, new features are being brought from beta versions to stable release.
+After a long year, new features are finally coming out of beta and making their way into a stable release. Also @jreesun appointed @odudex as the new lead maintainer of the project.
 
 ## Changes
 
 ### Battery Indicator
-Check battery status of M5stickV or Maix Amigo on top right of the screen
+Check battery status of M5stickV or Maix Amigo on top right of the screen.
 
 ### New Mnemonic From Camera
 Use camera as a source of entropy to quickly create a mnemonic.
 
 ### Tiny Seed - Export, Print, Punch, Manually Load or Scan
-Import and export a binary representation of your mnemonic, in a format popularized by Tiny Seed metal plates. BIP39 mnemonic words number indexes, ranging from 1 to 2048 are punched in binary format on a rectangular grid.
+Import and export a binary representation of your mnemonic, in a format popularized by Tiny Seed metal plates. BIP39 mnemonic words number, ranging from 1 to 2048 are punched in binary format on a rectangular grid.
 Krux will automatically convert a mnemonic to Tiny Seed format allowing to print or transcript it. You can also load a tiny seed toggling word bits on screen, or make use of machine vision capabilities of K210 chip to directly scan a Tiny Seed mnemonic backup stored on metal or paper.
 
 ### Stackbit - Import and Export
 Without needing tools, guides or dictionaries, import and export another metal plate backup format, where each of the four digits of the word's number is a sum of marked (punched) numbers 1,2,4 and 8.
 
 ### Enter Mnemonic as Word Numbers - Hex and Octal formats
-Also available in some metal plate backup formats, you could load your mnemonic words from its decimal BIP39 word index (1-2048), now can also load from its hexadecimal(0x1-0x800) or octal(01-04000) index.
+Also available in some metal plate backup formats, you could load your mnemonic words from its decimal BIP39 word number (1-2048), now you can also load from its hexadecimal(0x1-0x800) or octal(01-04000) word number.
 
 ### Encryption and Storage
-Conveniently store your mnemonics on device's internal flash or removable SD card, protecting them with encryption. If you feel uncomfortable storing your mnemonic in an unprotected QR code, you now also have the option to export encrypted QR codes, from which mnemonic content will only be accessible with a decryption key.
+Conveniently store your mnemonics on device's internal flash memory or removable SD card, protecting them with encryption. It is now possible to export encrypted QR codes too.
 
 ### Addresses
 Beyond verifying your wallet's receive addresses, you can now also list, export and print receive and change addresses.
 
-### SD Card Optimizations
-SD cards can now be inserted and removed at any time, making it easier to use it for signing transactions, messages and storing mnemonics.
+### SD Card Hot plugging
+SD cards can now be inserted and removed at any time, making it easier to use it for signing transactions, messages and storing encrypted mnemonics.
 
 ### Transcript Tools for QR codes
 Different visualization modes which make it easier to transcript QR codes.
 
 ### Transaction Details
-When signing a transaction more pages of information are presented, all details are shown before signature.
+When signing a transaction, more information is presented, ensuring that the user sees all details before signing.
 
 ### Tools
 #### Check SD Card
-Check if a SD card can be detected and read by your device and explore its content
+Check if the SD card is detected and explore its content.
 
 #### Delete Mnemonic
-Delete any stored encrypted mnemonic, on device's internal memory or SD card.
+Delete any stored encrypted mnemonic, on device's internal flash memory or SD card.
 
 #### Print Test QR
 Quickly print a test QR code to check and optimize your printer setup.
@@ -51,20 +51,20 @@ Enter a text input to create, print or transcript a QR code that can be later us
 Choose your color theme according to your preference.
 
 ### Thermal Printing and CNC
-More mnemonic export formats and tools to create and print generic QR codes to be used as passphrases or encryption keys. You can also export QR codes to gcode files and save them in SD cards, allowing you to machine them GRBL compatible CNCs, without the need of computers and CAD tools.
+More mnemonic export formats and tools to create and print generic QR codes to be used as passphrases or encryption keys. You can also export QR codes to gcode files and save them in SD cards, allowing you to machine them GRBL compatible CNCs without the need of computers and CAD tools.
 
 ### More Settings
 #### Persist
-Choose where you want to store your settings, on internal flash or SD card.
+Choose where you want to store your settings, on internal flash memory or SD card.
 
 #### Touchscreen
 If your device has touchscreen you can change the touch detection threshold.
 
 ### Languages
-Dutch translations was added.
+Dutch translations were added.
 
 ### UI Tweaks
-Small changes to optimize user experience
+Small changes to optimize user experience.
 
 ### Under the Hood
 Small bugfixes, optimizations and code refactoring, targeting better compatibility with coordinator softwares, faster boot and better RAM management.

README.md

@@ -114,6 +114,9 @@ the HW device and may not have all features implemented (e.g. scanning via camer
 Before executing the simulator, make sure you have installed the poetry extras:
 ```bash
 poetry install --extras simulator
+
+# To install alongside docs extras, use:
+poetry install --extras "simulator docs"
 ```
 
 Depending on the OS, it may be necessary to install zbar-tools:
@@ -286,11 +289,14 @@ Before change documentation, and run the mkdocs server, make sure you have insta
 
 ```bash
 poetry install --extras docs
+
+# To install alongside simulator extras, use:
+poetry install --extras "docs simulator"
 ```
 
 To change lateral and upper menus on generated documentation, see `mkdocs.yml` file on `nav` section. 
 
-To create or edit translations on documentation (TODO: need help!), read more [translations](il8n/README.md).
+To create or edit translations on documentation (TODO: need help!), read more [here](i18n/README.md).
 
 Once changes are made, you can run:
 

docs/faq.en.md

@@ -48,7 +48,7 @@ If you are using an M5StickV, the small screen makes it difficult for laptop web
 
 ## 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 is being detected and serial ports are being mounted by running:
+Make sure your device is being detected and serial ports are being mounted by running:
 ```bash
 ls /dev/ttyUSB*
 ```

docs/getting-started/index.en.md

@@ -1,4 +1,4 @@
-Krux is open-source Bitcoin signing firmware for devices that runs on the K210 chipset.
+Krux is open-source Bitcoin signing firmware for devices with the K210 chipset.
 
 Signing operations in Krux are done offline via QR code or via SD card. You can create/load your BIP-39 mnemonic, or import a wallet descriptor, and sign transactions all without having to plug the device into your computer (except to initially flash the firmware). It reads QR codes with its camera and outputs QR codes to its screen, or to paper via an optional [thermal printer attachment](../getting-started/printing.en.md). 
 

docs/getting-started/installing/from-gui.en.md

@@ -1,4 +1,4 @@
-This page explains how to install Krux from electron GUI desktop application.
+This page explains how to install Krux with KruxInstaller (GUI).
 
 ### Installing from a GUI
 

docs/getting-started/installing/from-pre-built-release.en.md

@@ -23,7 +23,7 @@ Extract the latest version of Krux you downloaded and enter the folder:
 unzip krux-vX.Y.Z.zip && cd krux-vX.Y.Z
 ```
 
-Connect the device to your computer via USB, power it on, and run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `amigo_ips`, or `bit`:
+Connect the device to your computer via USB (for Amigo, make sure you’re using bottom port), power it on, and run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `amigo_ips`, or `bit`:
 ```bash
 ./ktool -B goE -b 1500000 maixpy_DEVICE/kboot.kfpkg
 ```

docs/getting-started/installing/from-source.en.md

@@ -50,7 +50,7 @@ This will take around an hour or so to complete the first time. Subsequent build
 If all goes well, you should see a new `build` folder containing `firmware.bin` and `kboot.kfpkg` files when the build completes.
 
 ### Flash the firmware onto the device
-Connect the device to your computer via USB, power it on, and run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `amigo_ips`, `dock`, or `bit`:
+Connect the device to your computer via USB (for Amigo, make sure you’re using bottom port), power it on, and run the following, replacing `DEVICE` with either `m5stickv`, `amigo_tft`, `amigo_ips`, `dock`, or `bit`:
 ```bash
 vagrant ssh -c 'cd /vagrant; ./krux flash maixpy_DEVICE'
 ```

docs/getting-started/installing/from-test-release.en.md

@@ -1,4 +1,4 @@
-This page explains how to install Krux from an test, pre-built release.
+This page explains how to install Krux from a test, pre-built release.
 
 ### Warning