add info to docs

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

@@ -4,7 +4,7 @@ This page explains how to install Krux from electron GUI desktop application.
 
 You can install krux onto your K210-based device using our official desktop application, which we named [KruxInstaller](https://github.com/selfcustody/krux-installer), available for Linux and Windows.
 
-It uses the same methods described in [Installing from pre-build release](../installing/index.en.md), i.e. download, verify and flash the latest official release, without typing any command. Additionally you can install, through this application, [experimental compiled Krux binaries](https://github.com/odudex/krux_binaries).
+Under the hood the GUI uses the same methods described in [Installing from pre-build release](../installing/index.en.md), i.e. download, verify and flash the latest official release, but user won't need to type any command. Additionally you can install, through this application, [experimental compiled Krux binaries](https://github.com/odudex/krux_binaries).
 
 Keep in mind that this is software under development in the alpha stage and may be buggy. If you find any bugs or want to contribute to the project, please go to [issues](https://github.com/selfcustody/krux-installer/issues) or [fork it](https://github.com/selfcustody/krux-installer/fork).
 

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

@@ -33,9 +33,7 @@ For `dock` the `-b` parameter changes, so run:
 ./ktool -B dan -b 1500000 maixpy_dock/kboot.kfpkg
 ```
 
-If `ktool` fails to run, you may need to give it executable permissions with `chmod +x ./ktool`, or you might need to use "sudo" if your user don't have access to serial port. In Windows or Mac you may need to explicitly allow the tool to run by adding an exception for it.
 
-If the flashing process fails midway through, check the connection, restart the device, and try the command again.
 
 When the flashing process completes, you should see the Krux logo:
 
@@ -46,6 +44,30 @@ If after 30 seconds you still see a black screen, try power cycling the device b
 
 Congrats, you're now running Krux!
 
+#### Troubleshooting
+If `ktool` fails to run, you may need to give it executable permissions with `chmod +x ./ktool`, or you might need to use "sudo" if your user don't have access to serial port. In Windows or Mac you may need to explicitly allow the tool to run by adding an exception for it.
+
+If the flashing process fails midway through, check the connection, restart the device, and try the command again.
+
+Two serial ports are created when `Amigo` and `Bit` are connected to a PC. Sometimes Ktool will pick the wrong and flash will fail. Manually specify the serial port to overcome this issue using `-p` argument. Ex:
+
+```bash
+./ktool-linux -B goE -b 1500000 maixpy_amigo_tft/kboot.kfpkg -p /dev/ttyUSB1
+```
+
+Check por names of devices manager on Windows (ex: COM1, COM9), or list the ports on linux
+
+```bash
+ls /dev/ttyUSB*
+```
+
+List ports on Mac
+
+```bash
+ls /dev/cu.usbserial*
+```
+Different OS versions may have different port names, and the absence of ports may indicate a connection, driver or hardware related issue.
+
 #### A note about the Amigo
 Some Amigo screens have inverted x coordinates while others don’t.
 

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

@@ -74,8 +74,8 @@ If the flashing fails try one of the following common solutions:
 
 When the flashing process completes, you should see the Krux logo:
 
-<img src="../../img/maixpy_m5stickv/logo-125.png">
-<img src="../../img/maixpy_amigo_tft/logo-150.png">
+<img src="../../../img/maixpy_m5stickv/logo-125.png">
+<img src="../../../img/maixpy_amigo_tft/logo-150.png">
 
 If after 30 seconds you still see a black screen, try power cycling the device by holding down the power button for six seconds.
 

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

@@ -2,16 +2,10 @@ This page explains how to install Krux from an test, pre-built release.
 
 ### Warning
 
-Keep in mind that these are unsigned binaries, experimental compiled [Krux binaries](https://github.com/odudex/krux_binaries)
+Keep in mind that these are unsigned binaries
 
-### Download the choosed firmware
-
-- [Android](https://github.com/odudex/krux_binaries/tree/main/Android)
-- [Sipeed Amigo IPS](https://github.com/odudex/krux_binaries/tree/main/)
-- [Sipeed Amigo TFT]()
-- [Sipeed Bit]()
-- [Sipeed Dock]()
-- [Aimotion Yahboom]()
+### Download
+Download experimental compiled firmware or Android app: [Krux binaries](https://github.com/odudex/krux_binaries)
 
 #### Android
 
@@ -116,23 +110,6 @@ To Flash Yahboom Aimotion you'll have to manually specify the port, on this exam
 ./ktool-linux -B goE -b 1500000 -p /dev/ttyUSB0 yahboom/kboot.kfpkg
 ```
 
-#### Wiring
-
-For Maix Bit connect Buttons between pins 22, 21 and GND.
-
-22 is for "Enter ", 21 is for "Page"
-
-For Maix Dock connect a rotary encoder:
-
-```
-Encoder - Maix Dock
-   GND <->  GND
-     + <->  3V3e
-    SW <-> Pin 9
-    DT <-> Pin 10
-   CLK <-> Pin 11
-```
-
 
 
 

docs/parts.en.md

@@ -1,3 +1,21 @@
+# Krux compatible devices comparative table
+
+| Device | M5stickV | Maix Amigo | Maix Dock | Maix Bit |
+| ------------- | ------------- | ------------- | ------------- | ------------- |
+| Price | US$50 | US$47-63 | US$35 | US$35 |
+| Screen size  | 1.14" | 3.5" | 2.4" | 2.4" |
+| Screen resolution  | 135*240 | 320*480 | 240*320 | 240*320 |
+| Touchscreen  |  | Capacitive |  |  |
+| Camera  | OV7740 | OV7740 rear<br>GC0328 front | GC0328 | OV2640 or<br>OV5642 |
+| Battery  | 200mAh | 520mAh |  |  |
+| Requirements |  |  | Rotary encoder<br> 3D printed case<br> Soldering<br>Assembly | Buttons<br> 3D printed case<br> Soldering<br>Assembly |
+| Warnings  |  |  | *1 |  |
+
+*1: Some shops ship Maix Dock with soldered pin headers that do not fit in 3D printed enclosure
+
+All devices feature Kendryte K210 chip:
+28nm process, dual-core RISC-V 64bit @400MHz, 8 MB high-speed SRAM, DVP camera and MCU LCD interface, AES Accelerator, SHA256 Accelerator, FFT Accelerator
+
 # Part List
 
 ## M5StickV
@@ -29,7 +47,7 @@ You can expect to pay around $70 for one depending on which distributor you choo
 ## Maix Dock and Maix Bit
 For the DIYers, the Maix Dock and Bit are also supported but will require sourcing the parts individually and building the device yourself.
 
-Below are example implementations created by [odudex](https://twitter.com/odudex) with instructions on how to recreate them:
+Below are example implementations with instructions on how to recreate them:
 
 - [https://github.com/selfcustody/DockEncoderCase](https://github.com/selfcustody/DockEncoderCase)
 - [https://github.com/selfcustody/MaixBitCase](https://github.com/selfcustody/MaixBitCase)

i18n/README.md

@@ -52,7 +52,7 @@ Now, you will add the following `lo` entries to `plugins.i18n.nav_translations`
 
 - Home: `translation`;
 - Getting Started: `translation`;
-- Part List: `translation`;
+- Devices and Part List: `translation`;
 - FAQ: `translation`;
 - Support the Project: `translation`;
 - About: `translation`;
@@ -75,7 +75,7 @@ plugins:
       lo:
         Home: Ut enim
         Getting Started: Ad minim
-        Part List: Veniam
+        Devices and Part List: Veniam
         FAQ: Quis nostrud 
         Support the Project: Exercitation ullamco laboris
         About: Nisi
@@ -113,7 +113,7 @@ nav:
     - Using a Multisig Wallet: getting-started/using-a-multisig-wallet.en.md
     - Printing: getting-started/printing.en.md
     - Settings: getting-started/settings.en.md
-  - Part List: parts.en.md
+  - Devices and Part List: parts.en.md
   - FAQ: faq.en.md
   - Support the Project: support.en.md
 # ..configurations...

mkdocs.yml

@@ -68,7 +68,7 @@ nav:
     - Transcribing QR codes: getting-started/QR-transcript-tools.en.md
     - Settings: getting-started/settings.en.md
     - Tools: getting-started/tools.en.md
-  - Part List: parts.en.md
+  - Devices and Part List: parts.en.md
   - Encrypted QRCodes: encrypted-qr-codes.en.md
   - FAQ: faq.en.md
   - Support the Project: support.en.md