diff --git a/docs/css/custom.css b/docs/css/custom.css index a4b76c206..9bd546b1c 100644 --- a/docs/css/custom.css +++ b/docs/css/custom.css @@ -4,4 +4,9 @@ .md-typeset img.twemoji { margin: 0 !important; +} + +.md-typeset h5 { + color: black; + text-transform: none; } \ No newline at end of file diff --git a/docs/getting-started/features/tinyseed.en.md b/docs/getting-started/features/tinyseed.en.md index e135d260e..358e73c48 100644 --- a/docs/getting-started/features/tinyseed.en.md +++ b/docs/getting-started/features/tinyseed.en.md @@ -12,6 +12,7 @@ The examples below have been crated so that you can test the workflow for scanni ## Size, Offset and Padding Reference The general logic for how these are processed is: + 1. Krux first looks for a square (Which works best if with a well lit square, with clean edges, on a dark background) 2. This square is checked and if the ratio of length to height is within a defined range for the given seed type, the square is further processed. (Uses the aspect_high and aspect_low variables) 3. An X and Y offset are applied to work out the corner of the seed grid within the seed plate. Some devices like the Maix Amigo use a mirrored coordinate system and some seed types will have a slightly different layout on the front and back of the plate. (Uses the x_offset and y_offset variables, p0 for the front face and p1 for the reverse face) diff --git a/docs/getting-started/installing/from-gui.en.md b/docs/getting-started/installing/from-gui.en.md index d22a72366..d0d15cec2 100644 --- a/docs/getting-started/installing/from-gui.en.md +++ b/docs/getting-started/installing/from-gui.en.md @@ -6,13 +6,13 @@ available for Linux and Windows. Download the installer by choosing the right asset for your operating system from our [Github releases page](https://github.com/selfcustody/krux-installer/releases): -| **Operational System** | **File** | -|------------------------------------------------------------|:----------------------------------:| -| Windows | `krux-installer_0.0.13.exe*` | -| Debian-based: Ubuntu, PopOS, etc... | `krux-installer_0.0.13_amd64.deb*` | -| RedHat-based: Fedora, etc... | `krux-installer-0.0.13.x86_64.rpm*`| -| Any linux distribution | `krux-installer-0.0.13.AppImage*` | -| Package for Archlinux on [AUR](https://aur.archlinux.org/).| `krux-installer-bin` | +| **Operational System** | **File** | +|------------------------------------------------------------|:------------------------------------------:| +| Windows | `{{latest_installer_underline}}.exe` | +| Debian-based: Ubuntu, PopOS, etc... | `{{latest_installer_underline}}_amd64.deb` | +| RedHat-based: Fedora, etc... | `{{latest_installer}}.x86_64.rpm` | +| Any linux distribution | `{{latest_installer}}.AppImage` | +| Package for Archlinux on [AUR](https://aur.archlinux.org/).| `krux-installer-bin` | ### Verify files If you trust the project developers, you can skip to [install](#install): @@ -33,10 +33,10 @@ If you trust the project developers, you can skip to [install](#install): ```pwsh # Compare this output: - (Get-FileHash 'krux-installer_0.0.13.exe').Hash + (Get-FileHash '{{latest_installer_underline}}.exe').Hash # With this: - Get-Content 'krux-installer_0.0.13.exe.sha256.txt' + Get-Content '{{latest_installer_underline}}.exe.sha256.txt' ``` @@ -44,7 +44,7 @@ If you trust the project developers, you can skip to [install](#install): Debian-based ```bash - sha256sum --check ./krux-installer_0.0.13_amd64.deb.sha256.txt + sha256sum --check ./{{latest_installer_underline}}_amd64.deb.sha256.txt ``` @@ -52,7 +52,7 @@ If you trust the project developers, you can skip to [install](#install): RedHat-based ```bash - sha256txt --check ./krux-installer-0.0.13.x86_64.rpm.sha256.txt + sha256txt --check ./{{latest_installer}}.x86_64.rpm.sha256.txt ``` @@ -60,7 +60,7 @@ If you trust the project developers, you can skip to [install](#install): Any Linux distribution ```bash - sha256sum --check ./krux-installer-0.0.13.AppImage.sha256.txt + sha256sum --check ./{{latest_installer}}.AppImage.sha256.txt ``` @@ -80,10 +80,10 @@ Then you can verify: | System | Command | |------------------------|-------------------------------------------------------| -| Windows (powershell) | `gpg --verify krux-installer_0.0.13.exe.sig` | -| Debian-based | `gpg --verify ./krux-installer_0.0.13_amd64.deb.sig` | -| RedHat-based | `gpg --verify ./krux-installer-0.0.13.x86_64.rpm.sig` | -| Any Linux distribution | `gpg --verify ./krux-installer-0.0.13.AppImage.sig` | +| Windows (powershell) | `gpg --verify {{latest_installer_underline}}.exe.sig` | +| Debian-based | `gpg --verify ./{{latest_installer_underline}}_amd64.deb.sig` | +| RedHat-based | `gpg --verify ./{{latest_installer}}.x86_64.rpm.sig` | +| Any Linux distribution | `gpg --verify ./{{latest_installer}}.AppImage.sig` | > ⚠️ TIP: If the verification was successful, you may get a message similar to: `Good signature from "qlrddev "` @@ -102,7 +102,7 @@ Each system require different steps to install: Windows