zephyr-installer 1.0.0__tar.gz

zephyr_installer-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

zephyr_installer-1.0.0/PKG-INFO

@@ -0,0 +1,354 @@
+Metadata-Version: 2.4
+Name: zephyr-installer
+Version: 1.0.0
+Summary: Install embedded C libraries into a Zephyr application, as Zephyr modules
+Author-email: "Nima Askari (NimaLTD)" <nima.askari@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/nimaltd/zephyr-installer
+Project-URL: Issues, https://github.com/nimaltd/zephyr-installer/issues
+Keywords: zephyr,zephyr-rtos,nrf-connect-sdk,embedded,installer,kconfig,nimaltd
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Embedded Systems
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# zephyr-installer
+
+Installs embedded C libraries into a Zephyr application, nRF Connect SDK ones included.
+
+A library written for any project has no idea what a Zephyr module is. This copies it into your application, makes it a module, adds it to the build, and switches it on in `prj.conf`, so `west build` picks it up and its settings live in Kconfig like everything else in Zephyr.
+
+It works with any library that has an `installer.yml` at the root of its repository. I wrote it for my own [NimaLTD](https://github.com/nimaltd) libraries, and they all have one, but nothing in it is tied to them: add an `installer.yml` to yours, as shown [below](#for-someone-writing-a-library), and it installs the same way. The same file serves [stm32-installer](https://github.com/nimaltd/stm32-installer), so one library can be installed into an STM32 project and a Zephyr application alike.
+
+Every command below uses `owner/example`, the library's GitHub owner and name, such as `nimaltd/ee24`. Put the real ones in its place.
+
+---
+
+## Installing a library
+
+Install the installer once. This needs internet:
+
+```bash
+pip install zephyr-installer
+```
+
+Then, from your application's folder, the one holding `CMakeLists.txt` and `prj.conf`:
+
+```bash
+zephyr-installer owner/example
+```
+
+Then build as always:
+
+```bash
+west build -b nrf52840dk/nrf52840
+```
+
+To update it later, `pip install --upgrade zephyr-installer`. To remove it, `pip uninstall zephyr-installer`.
+
+On Windows, if `zephyr-installer` is not found after installing, pip put it in a folder that is not on your PATH. `python -m zephyr_installer owner/example` runs the same thing.
+
+### What happens
+
+Take `example`, installed into an application called `app`:
+
+```
+app/
+  CMakeLists.txt         one block added, above find_package(Zephyr)
+  prj.conf               one block added, CONFIG_EXAMPLE=y and what it needs
+  modules/example/
+    example.h            the library's files, as its installer.yml lists them
+    example.c
+    zephyr/
+      module.yml         written by the installer: the library as a Zephyr module
+      CMakeLists.txt     its files, built when CONFIG_EXAMPLE is set
+      Kconfig            CONFIG_EXAMPLE and the library's settings
+```
+
+The block in your `CMakeLists.txt` adds the library's folder to `ZEPHYR_EXTRA_MODULES`. That is how Zephyr is told about a module outside the west workspace, and it has to come before `find_package(Zephyr)`, which is when Zephyr looks:
+
+```cmake
+cmake_minimum_required(VERSION 3.20.0)
+
+# >>> zephyr-installer: example >>>
+# Added by zephyr-installer. Delete this block, and example's block in
+# the Kconfig file, to drop the library from the build.
+list(APPEND ZEPHYR_EXTRA_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/modules/example")
+# <<< zephyr-installer: example <<<
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+```
+
+The block in `prj.conf` switches the library on, with the symbols it needs and a list of its settings:
+
+```
+# >>> zephyr-installer: example >>>
+# Added by zephyr-installer, and written again on every install, so set
+# example's settings below this block rather than in it.
+# Its settings, as they are unless you set them:
+#   CONFIG_EXAMPLE_POLL_CHUNK=32
+CONFIG_I2C=y
+CONFIG_EXAMPLE=y
+# <<< zephyr-installer: example <<<
+```
+
+A symbol you already set yourself is not set again in the block, whatever value you gave it. `CONFIG_I2C=n` of yours stays `n`, and the installer says so before it writes anything, rather than quietly undoing your choice with a later line.
+
+Both files are copied aside before they change, as `CMakeLists.txt.20261013-170013.bak` and the like, and the files keep their own line endings. Installing twice changes nothing the second time.
+
+The module is called `example_lib`, not `example`. Zephyr keeps one module per name, and one added by the application quietly takes the place of a module of the same name in the workspace: a library called `littlefs` would otherwise replace Zephyr's own littlefs.
+
+### Settings
+
+A library's settings are Kconfig symbols, set in `prj.conf` like any other, below the installer's block:
+
+```
+CONFIG_EXAMPLE_POLL_CHUNK=64
+```
+
+`west build -t menuconfig` shows them too, under the library's name. The C code reads them as `CONFIG_EXAMPLE_POLL_CHUNK`, which Zephyr gives every file of the build.
+
+### Which Kconfig file
+
+`prj.conf` is the one most applications have. When yours has more, such as a board's own file in `boards/`, the installer asks once which one gets the libraries:
+
+```
+This application has more than one Kconfig file: prj.conf, boards/nrf52840dk_nrf52840.conf
+Kconfig file for the libraries [prj.conf]:
+```
+
+Press Enter for `prj.conf`. `--conf boards/nrf52840dk_nrf52840.conf` answers it on the command line, and a file that does not exist yet is created. One answer covers every library of that run, a library it needs included. On an update, a library stays in the file that already has its block, without a question. In a script, where nobody can answer, `prj.conf` is taken.
+
+### What you see
+
+A first install from GitHub, into an application whose `prj.conf` turned printk off:
+
+```
+Fetching owner/example ...
+
+example 1.2.0
+Driver for the X chip
+driver / storage
+
+Requirements
+  note    CONFIG_I2C=y goes into prj.conf
+  check   prj.conf sets CONFIG_PRINTK=n, and example needs y
+          Your line is kept. Change it if the library is to work.
+  note    Needs I2C, 400 kHz
+          Enable it in your board's devicetree, or in an overlay of the application.
+
+Folder to install example into [modules/example]:
+
+Files
+  written modules/example/example.h
+  written modules/example/example.c
+
+Project
+  updated Zephyr module  Wrote example_lib: zephyr/module.yml, zephyr/CMakeLists.txt, zephyr/Kconfig.
+  updated CMakeLists.txt  Added example to CMakeLists.txt.
+          backup: CMakeLists.txt.20261013-170013.bak
+  updated prj.conf  Added example to prj.conf.
+          backup: prj.conf.20261013-170014.bak
+
+Done. #include "example.h" and you are away.
+```
+
+The hardware a library uses is yours to give it in the devicetree, which the installer names but does not change.
+
+### What to install
+
+The argument can be any of these, and you can give several at once:
+
+| You have | You type |
+|---|---|
+| Nothing yet, and internet | `zephyr-installer owner/example` |
+| The library's GitHub address | `zephyr-installer https://github.com/owner/example` |
+| The zip from GitHub's **Download ZIP** | `zephyr-installer D:/Downloads/example-main.zip` |
+| That zip unpacked, anywhere on disk | `zephyr-installer D:/Downloads/example-main` |
+| The library's folder, already inside your application | `zephyr-installer modules/example` |
+
+A bare name with no owner, like `example`, is a NimaLTD library, `nimaltd/example` on GitHub, unless a folder of that name exists where you run it, in which case the folder is used. A path that does not exist is reported as missing rather than looked up on GitHub.
+
+### Options
+
+| Option | What it does |
+|---|---|
+| `--conf boards/x.conf` | The Kconfig file that switches the libraries on. Asked when the application has more than one, `prj.conf` otherwise. See [Which Kconfig file](#which-kconfig-file) |
+| `--dir libs/example` | The folder of your application to install into, for one library. Asked for when not given, with `modules/<name>` as the answer if you just press Enter, or the folder it is already in |
+| `--project D:/work/app` | Your application's folder, when you are not running from it |
+| `--ref v2.0.0` | A tag, a branch or a commit to take from GitHub. When not given, `main`, or `master` for a repository that has no `main` |
+| `--with littlefs` | Take this part of the library without being asked. Give it once for each part |
+| `--without littlefs` | Leave this part out, or take it out of a library already installed |
+| `--version` | Show which version of the installer you have, and do nothing else |
+
+### Updating a library
+
+Run the same command again. Every file of the library is replaced, so an update updates, and the module's three files are written again from the new `installer.yml`, so a source file the new version adds is built without you editing anything. A file that did not change is left alone, so the build does not configure again for nothing.
+
+What you wrote between `USER CODE BEGIN` and `USER CODE END` in a library's file is kept. Outside those lines, the next install replaces it, and when that would lose something of yours the file is saved beside it first, as a `.bak`.
+
+The record of what is installed, and where, is `.zephyr-installer.json` in your application's folder. Keep it in version control with the rest.
+
+### A library that needs another
+
+You install only the one you want, and what it needs goes in first, each as a module of its own with its own blocks. One already in the application at a version that will do is left alone. Everything is fetched before anything is installed, so when a library cannot be had, your application is left as it was.
+
+### Without internet
+
+On a machine that has internet, `pip download zephyr-installer` saves one file, the installer, which needs nothing else. Download the library too, from the green **Code** button, **Download ZIP**. Then, on the machine with no internet:
+
+```bash
+pip install zephyr_installer-1.0.0-py3-none-any.whl
+zephyr-installer D:/Downloads/example-main.zip
+```
+
+If the library needs another, give that zip on the same line. A private repository installs by name with a GitHub token that can read it in `GITHUB_TOKEN`, and a proxy is taken from `HTTPS_PROXY`.
+
+---
+
+## For someone writing a library
+
+Put an `installer.yml` at the root of the repository. Any library can have one, whoever wrote it, and the one file serves both zephyr-installer and stm32-installer: each reads its own keys and leaves the other's alone.
+
+Every key zephyr-installer reads is below, each with what it does. Only `name` and `files` are required; leave out what your library does not need.
+
+```yaml
+name: example                      # the library's name, its folder and its Kconfig symbol
+description: Driver for the X chip # one line, shown while installing and in menuconfig
+repository: https://github.com/owner/example  # where it comes from
+license: Apache-2.0                # the licence's SPDX name
+version: 1.0.0                     # only when the first header has no @version tag
+
+kind: driver                       # driver, middleware, rtos, protocol, filesystem,
+                                   # utility or bsp
+category: storage                  # sensor, storage, display, communication, wireless,
+                                   # rtos, timing, power, input, math or system
+provides: []                       # what it gives other libraries: [rtos] for an RTOS
+
+requires:
+  zephyr_installer: 1.0.0          # the oldest zephyr-installer that reads this file
+  libraries:                       # other libraries, installed first when missing
+    - osal >= 1.0.0                # no owner means nimaltd; >= the oldest that will do
+    - owner/lib                    # anyone else's, as owner/name
+  kconfig:                         # symbols it needs, set in the Kconfig file
+    - I2C                          # a symbol alone is set to y
+    - MAIN_STACK_SIZE=2048         # or SYMBOL=value: y, n, a number, 0x.. or "text"
+  peripherals:                     # hardware it uses, named to the user
+    - type: i2c                    # what it is
+      count: 1                     # how many
+      note: 400 kHz                # how to set it up
+
+install:
+  layout: mirror                   # mirror keeps the repository's folders,
+                                   # flat (the default) puts every file at the top
+  include_dirs: [src]              # include folders, only when the guess is wrong
+  defines:                         # given to the whole build, NAME or NAME=value
+    - EXAMPLE_FAST
+
+files:
+  headers:                         # .h files; the first is the one to #include
+    - src/example.h
+    - src/port/*.h                 # a wildcard, matched the way a shell would
+  sources:                         # .c files, built when the library is switched on
+    - src/example.c
+    - from: src/port/spi.c         # a file that goes somewhere of its own,
+      to: port/spi.c               # whatever the layout says
+
+options:                           # parts the user chooses at install
+  littlefs:                        # the name typed after --with
+    description: LittleFS file system on the flash  # the question asked
+    libraries:                     # libraries this part needs, installed first
+      - littlefs >= 2.11.0
+    files:                         # its files, written like files above
+      sources:
+        - src/example_lfs.c
+
+extras:                            # copied as they are, never compiled
+  - LICENSE.md                     # LICENSE.md and NOTICE are the default,
+  - NOTICE                         # so leave this out if that is all
+  - README.md
+
+zephyr:                            # read by zephyr-installer only
+  kconfig: EXAMPLE                 # the library's symbol; the name in capitals when left out
+  settings:                        # Kconfig symbols the user sets, CONFIG_<name> in the code
+    - name: EXAMPLE_POLL_CHUNK     # the symbol, best started with the library's own
+      type: int                    # bool, int, hex or string
+      default: 32                  # required: true or false, a number, 0x.. or text
+      range: [1, 32768]            # int and hex only: [smallest, largest]
+      prompt: Bytes read per call  # one line, shown in menuconfig
+      help: |                      # as many lines as it takes, shown in menuconfig
+        A read by polling moves at most this many bytes per call.
+```
+
+Keys only stm32-installer reads, such as `requires.installer`, `requires.hal_modules` and `requires.rtos`, can stay in the same file. This installer skips them.
+
+Leave `version` out. The installer reads the version from the `@version` tag in the file comment of the first header listed, so it is written in the code and nowhere else.
+
+`requires.zephyr_installer` is the oldest zephyr-installer that reads the file correctly. It is checked before anything else in the file is read, so an older installer stops with a message saying to update, rather than read the file wrongly. Write it as three numbers, `1.0.0`: unquoted, YAML reads `1.10` as the decimal number `1.1`, and that is refused.
+
+### Settings in the code
+
+Zephyr hands every file of the build its configuration, so the library's code reads a setting as a macro. One header can serve Zephyr and any other project, taking the setting from Kconfig when it is there:
+
+```c
+#ifdef CONFIG_EXAMPLE_POLL_CHUNK
+#define EXAMPLE_POLL_CHUNK          CONFIG_EXAMPLE_POLL_CHUNK
+#endif
+
+#ifndef EXAMPLE_POLL_CHUNK
+#define EXAMPLE_POLL_CHUNK          32U
+#endif
+```
+
+A `bool` setting that is off is not defined at all, which is how Kconfig does it, so test it with `#ifdef` or `IS_ENABLED()`. A `string` arrives in quotes, ready for C.
+
+Each setting is checked at install, since all of it is written into a Kconfig file: a default of the wrong type, one outside its range, or a name Kconfig would refuse stops the install with the reason, before anything is written.
+
+### A library with its own module
+
+A library that ships a `zephyr/module.yml` of its own, listed under `extras` or `files` so it is installed, knows its build better than the installer does. Its module is used as it is: nothing is written into its `zephyr` folder, and only the two blocks in the application are added. `zephyr.kconfig` then names the symbol its Kconfig defines, for the block in `prj.conf` to set.
+
+---
+
+## Running the tests
+
+The shared core, [core-installer](https://github.com/nimaltd/core-installer), is a git submodule in `src/core`, so clone with it:
+
+```bash
+git clone --recursive https://github.com/nimaltd/zephyr-installer.git
+```
+
+In a clone made without `--recursive`, `git submodule update --init` fetches it. Then:
+
+```bash
+python test/run_tests.py
+```
+
+CI also installs a small library from `test/e2e/` into an application, builds it with Zephyr for `native_sim`, runs it, and checks what it prints, so every release is known to build with real Zephyr.
+
+---
+
+## Support
+
+I write these tools and libraries in my own time and give them away, because good tools should be easy to get. If this one saved you an afternoon, there are two things that genuinely help:
+
+**Star the repo.** It costs you one click, it helps other engineers find the tool, and it is the main reason I keep going.
+
+**[Buy me a coffee on Ko-fi](https://ko-fi.com/nimaltd).** Any amount is a real motivation to keep writing, documenting and maintaining this work.
+
+[![GitHub](https://img.shields.io/badge/GitHub-Follow-black?style=for-the-badge&logo=github)](https://github.com/NimaLTD)
+[![YouTube](https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube)](https://youtube.com/@nimaltd)
+[![Instagram](https://img.shields.io/badge/Instagram-Follow-purple?style=for-the-badge&logo=instagram)](https://instagram.com/github.nimaltd)
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?style=for-the-badge&logo=linkedin)](https://linkedin.com/in/nimaltd)
+[![Email](https://img.shields.io/badge/Email-Contact-red?style=for-the-badge&logo=gmail)](mailto:nima.askari@gmail.com)
+[![Ko-fi](https://img.shields.io/badge/Ko--fi-Support-orange?style=for-the-badge&logo=ko-fi)](https://ko-fi.com/nimaltd)
+
+---
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/nimaltd/zephyr-installer/blob/main/LICENSE).