Fixed README

.github/workflows/ci.yml

@@ -24,9 +24,6 @@ jobs:
           list-files: json
           filters: |
             change:
-              - '.gitignore'
-              - '.pylintrc'
-              - 'TODO.md'
               - 'CHANGELOG.md'
               - 'LICENSE'
             

README.md

@@ -54,17 +54,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:
 
-<details>
-<summary>Install `brew` package manager</summary>
+#### Install `brew` package manager
 
 ```bash
 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
 ```
 
-</details>
-
-<details>
-<summary>Install latest python</summary>
+#### Install latest python
 
 ```bash
 brew install python
@@ -76,10 +72,7 @@ and add this line to your `~/.zshrc`:
 alias python=python3
 ```
 
-</details>
-
-<details>
-<summary> Ensure openssl have a correct link</summary>
+#### 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
@@ -101,10 +94,8 @@ brew link --force openssl
 
 This ensures that the OpenSSL libraries are available in the expected
 locations that Python can find and use.
-</details>
 
-<details>
-<summary>Patch your zshrc</summary>
+#### 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,
@@ -124,8 +115,6 @@ OPENSSL_FULL_VERSION=`openssl --version | awk ' { print $2}'`
 export DYLD_LIBRARY_PATH="/opt/homebrew/Cellar/openssl@$OPENSSL_MAJOR_VERSION/$OPENSSL_FULL_VERSION/lib:$DYLD_LIBRARY_PATH"
 ```
 
-</details>
-
 ### Install poetry
 
 Make sure you have `poetry` installed:
@@ -165,35 +154,25 @@ git submodule update --init
 Krux-Installer uses `poe` task manager for formatting, linting, tests,
 coverage and build.
 
-<details>
-<summary>See all available tasks</summary>
+### See all available tasks
 
 ```bash
 poetry run poe
 ```
 
-</details>
-
-<details>
-<summary>Format code</summary>
+### Format code
 
 ```bash
 poetry run poe format
 ```
 
-</details>
-
-<details>
-<summary>Lint</summary>
+### Lint
 
 ```bash
 poetry run poe lint
 ```
 
-</details>
-
-<details>
-<summary>Test and coverage</summary>
+### Test and coverage
 
 ```bash
 poetry run poe test
@@ -209,28 +188,20 @@ poetry run poe test --no-xvfb
 You can see all coverage results opening you browser and type
 `file:///<folder>/krux-installer/htmlcov/index.html` (assuming
 `folder` is where you placed the `krux-installer` project).
-</details>
 
-<details>
-<summary>Build for any Linux distribution</summary>
+### Build for any Linux distribution
 
 ```bash
 poetry run poe build-linux
 ```
 
-</details>
-
-<details>
-<summary>Build for MacOS</summary>
+### Build for MacOS
 
 ```bash
 poetry run poe build-macos
 ```
 
-</details>
-
-<details>
-<summary>Build for Windows</summary>
+### Build for Windows
 
 ```bash
 poetry run poe build-win
@@ -245,4 +216,3 @@ It will export all project in a
 
 To more options see [.ci/create-spec.py](./.ci/create-spec.py) against the PyInstaller
 [options](https://pyinstaller.org).
-</details>