linted CHANGELOG and README

CHANGELOG.md

@@ -1,51 +1,55 @@
-- **0.0.2-alpha**
-  - code refactoration from `nodejs` to `python`;
-  - re-build project from `electron` to `kivy`;
-  - Support for MacOS (arm64 and intel processors);
-  - Support to download older versions;
-  - Support to devices according to the appropriate version:
-    - M5stickV;
-    - Amigo;
-    - Dock;
-    - Bit;
-    - Yahboom;
-    - Cube;
-  - Flash made with the `ktool` from its source;
-  - Wipe made with the `ktool` from its source;
-  - Added settings page:
-    - Enable change path of downloaded assets;
-    - Enable change of flash baudrate;
-    - Enable change of locale;
-  - Added about page
-  - Locale support for 10 languages:
-    - af_ZA (South Africa Afrikaans);
-    - en_US (USA English);
-    - es_ES (Spain spanish);
-    - fr_FR (France french);
-    - it_IT (Italian);
-    - ko_KR (South Korean korean);
-    - nl_NL (Netherlands dutch);
-    - pt_BR (Brazilian portuguese);
-    - ru_RU (Russian cyrillic);
-    - zh_CN (Simplified chinese)
+# CHANGELOG
+
+## 0.0.2-alpha
+
+- code refactoration from `nodejs` to `python`;
+- re-build project from `electron` to `kivy`;
+- Support for MacOS (arm64 and intel processors);
+- Support to download older versions;
+- Support to devices according to the appropriate version:
+  - M5stickV;
+  - Amigo;
+  - Dock;
+  - Bit;
+  - Yahboom;
+  - Cube;
+- Flash made with the `ktool` from its source;
+- Wipe made with the `ktool` from its source;
+- Added settings page:
+  - Enable change path of downloaded assets;
+  - Enable change of flash baudrate;
+  - Enable change of locale;
+- Added about page
+- Locale support for 10 languages:
+  - af_ZA (South Africa Afrikaans);
+  - en_US (USA English);
+  - es_ES (Spain spanish);
+  - fr_FR (France french);
+  - it_IT (Italian);
+  - ko_KR (South Korean korean);
+  - nl_NL (Netherlands dutch);
+  - pt_BR (Brazilian portuguese);
+  - ru_RU (Russian cyrillic);
+  - zh_CN (Simplified chinese)
 
-- **0.0.1**
-  - Major updates dependencies:
-    - `electron`: 28.1.0;
-    - `vite-plugin-electron`: 0.15.5;
-    - `wdio-electron-service`: 6.0.2.
-  - Minor updates:
-    - `@wdio/cli`: 8.27.0;
-    - `@wdio/globals`: 8.27.0;
-    - `@wdio/local-runner`: 8.27.0;
-    - `@wdio/mocha-framework`: 8.27.0;
-    - `@wdio/spec-reporter`: 8.27.0;
-    - `vue`: 3.3.13;
-    - `vue-tsc`: 1.8.26;
-    - `vuetify`: 3.4.8;
-  - Refactored `test/e2e/specs`:
-    - to suit `wdio-electron-service` major updates that break E2E tests;
-    - renamed extensions to `mts` to suit `vite-plugin-electron`;
-    - updated krux firmware version checks to `23.09.1`;
-  - Updated `openssl` for windows to `3.2.0` *;
-  - Removed MacOS release since the current approach did not worked well on MacOS;
+## 0.0.1
+
+- Major updates dependencies:
+  - `electron`: 28.1.0;
+  - `vite-plugin-electron`: 0.15.5;
+  - `wdio-electron-service`: 6.0.2.
+- Minor updates:
+  - `@wdio/cli`: 8.27.0;
+  - `@wdio/globals`: 8.27.0;
+  - `@wdio/local-runner`: 8.27.0;
+  - `@wdio/mocha-framework`: 8.27.0;
+  - `@wdio/spec-reporter`: 8.27.0;
+  - `vue`: 3.3.13;
+  - `vue-tsc`: 1.8.26;
+  - `vuetify`: 3.4.8;
+- Refactored `test/e2e/specs`:
+  - to suit `wdio-electron-service` major updates that break E2E tests;
+  - renamed extensions to `mts` to suit `vite-plugin-electron`;
+  - updated krux firmware version checks to `23.09.1`;
+- Updated `openssl` for windows to `3.2.0` *;
+- Removed MacOS release since the current approach did not worked well on MacOS;

README.md

@@ -10,10 +10,10 @@
 Krux Installer is a GUI based tool to flash [Krux](https://github.com/selfcustody/krux)
 without typing any command in terminal for [flash the firmware onto the device](https://selfcustody.github.io/krux/getting-started/installing/#flash-the-firmware-onto-the-device).
 
+## Installing
 
-# Installing:
-
-There are pre-built [releases](https://github.com/selfcustody/krux-installer/releases) for:
+There are pre-built
+[releases](https://github.com/selfcustody/krux-installer/releases) for:
 
 * Linux:
   * Debian-like
@@ -23,7 +23,6 @@ There are pre-built [releases](https://github.com/selfcustody/krux-installer/rel
   * intel processors
   * arm64 processors (M1/M2/M3)
 
-
 To build it from the source, please follow the steps below:
 
 * [System setup](/#system-setup)
@@ -50,6 +49,7 @@ Make sure you have python:
 ```bash
 python --version
 ```
+
 ### Linux
 
 Generally, all Linux come with python.
@@ -62,13 +62,13 @@ Follow the instructions at [python.org](https://www.python.org/downloads/windows
 
 Before installing `krux-installer` source code, you will need prepare the system:
 
-#### Install `brew` package manager:
+#### Install `brew` package manager
 
 ```bash
 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
 ```
 
-#### Install latest `python`:
+#### Install latest `python`
 
 ```bash
 brew install python
@@ -80,13 +80,15 @@ and add this line to your `~/.zshrc`:
 alias python=python3
 ```
 
-#### Ensure `openssl` have a correct link:
+#### Ensure `openssl` have a correct link
 
-Python's `ssl` module relies on OpenSSL for cryptographic operations. Ensure that OpenSSL
-is installed on your system and is compatible with the Python version you're using.
+Python's `ssl` module relies on OpenSSL for cryptographic operations.
+Ensure that OpenSSL is installed on your system and is compatible with the
+Python version you're using.
 
-Since we expect that you're using the Python installed with Homebrew, it's recommended to
-install OpenSSL through Homebrew if it's not already installed:
+Since we expect that you're using the Python installed with Homebrew,
+it's recommended to install OpenSSL through Homebrew if it's not already
+installed:
 
 ```bash
 brew install openssl
@@ -101,18 +103,19 @@ brew link --force openssl
 This ensures that the OpenSSL libraries are available in the expected
 locations that Python can find and use.
 
-#### Patch your zshrc:
+#### Patch your zshrc
 
 Library paths on MacOS involves verifying that the environment variables and system
 configurationsare correctyly set to find the necessary libraries, such as OpenSSL,
 which is crucial for the `ssl` module in Python.
 
 On MacOS, the dynamic linker tool `dyld` uses environment variabes to locate shared
-libraries. The primary environment variable for specifying library paths is `DYLD_LIBRARY_PATH`.
+libraries. The primary environment variable for specifying library paths is
+`DYLD_LIBRARY_PATH`.
 
-Adding the lines below to your `~/.zshrc` (or similar) the `DYLD_LIBRARY_PATH` will be set
-each time you open a new terminal session (and therefore the OpenSSL libraries
-`libcrypto.dylib` and `libssl.dylib` will can be found):
+Adding the lines below to your `~/.zshrc` (or similar) the `DYLD_LIBRARY_PATH`
+will be set each time you open a new terminal session (and therefore the OpenSSL
+libraries `libcrypto.dylib` and `libssl.dylib` will can be found):
 
 ```bash
 OPENSSL_MAJOR_VERSION=`openssl --version | awk '{ print $2}' | cut -d . -f1`
@@ -133,7 +136,8 @@ properly [configure its options](https://pipx.pypa.io/latest/installation/#insta
 
 ## Download sources
 
-Clone the repository
+Clone the repository:
+
 ```bash
 git clone --recurse-submodules https://github.com/krux-installer.git
 ```
@@ -176,7 +180,7 @@ poetry run poe lint
 
 ### Test
 
-```
+```bash
 poetry run poe test
 ```
 
@@ -191,24 +195,26 @@ poetry run poe test --no-xvfb
 At the moment, you'll need to [patch some code on `kivy`](https://github.com/kivy/kivy/issues/8653#issuecomment-2028509695)
 to build the Graphical User Interface:
 
-**Debian/Fedora/MacOS**
+#### Build for Debian, Fedora, MacOS
 
-```
+```bash
 poetry run poe patch-nix
 poetry run poe build-nix
 ```
 
-**Windows**:
+#### Build for Windows
 
-```
+```bash
 poetry run poe patch-win
 poetry run poe build-win
 ```
 
-It will export all project in a [`one-file`](https://pyinstaller.org/en/stable/usage.html#cmdoption-F) binary:
+It will export all project in a
+[`one-file`](https://pyinstaller.org/en/stable/usage.html#cmdoption-F) binary:
 
-- linux: `./dist/krux-installer`
-- macOS: `./dist/krux-installer.app/Contents/MacOS/krux-installer`
-- windows: `./dist/krux-installer.exe`
+* linux: `./dist/krux-installer`
+* macOS: `./dist/krux-installer.app/Contents/MacOS/krux-installer`
+* windows: `./dist/krux-installer.exe`
 
-To more options see [.ci/create-spec.py](./.ci/create-spec.py) against the PyInstaller [options](https://pyinstaller.org)
+To more options see [.ci/create-spec.py](./.ci/create-spec.py)
+against the PyInstaller [options](https://pyinstaller.org).