All of lore.kernel.org
 help / color / mirror / Atom feed
From: Trevor Woerner <twoerner@gmail.com>
To: yocto-patches@lists.yoctoproject.org
Subject: [wic] README.md: update env usage
Date: Tue,  7 Apr 2026 14:49:32 -0400	[thread overview]
Message-ID: <20260407184932.3466366-1-twoerner@gmail.com> (raw)

Update the README to clarify that the --vars argument works with either
one BitBake-generated environment file, or by pointing it at a directory
of environment files.

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
 README.md | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 8ee02d89738b..c6fed6626e10 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,13 @@
 # WIC Standalone
 
 This packages the OpenEmbedded Image Creator (`wic`) as an installable
-Python CLI using Hatch. It either consumes BitBake-exported environment
-files (generated via `bitbake -c rootfs_wicenv <image>`) or will invoke
-BitBake directly (if available on the PATH).
+Python CLI using Hatch. It either consumes a BitBake-exported
+environment file or folder (generated via `bitbake -c rootfs_wicenv
+<image>`) or will invoke BitBake directly (if available on the PATH).
 
 ## Quick start
 
-### Using wicenv
+### Using wicenv (one environment file)
 1. Ensure you have a BitBake-generated `<image>.env` file (from `rootfs_wicenv`).
 2. Install locally for development:
    ```bash
@@ -18,6 +18,17 @@ BitBake directly (if available on the PATH).
    hatch run wic --vars /path/to/<image>.env --help
    ```
 
+### Using wicenv (environment folder)
+1. Ensure you have a folder with BitBake-generated `<image>.env` files (from `rootfs_wicenv`).
+2. Install locally for development:
+   ```bash
+   hatch shell
+   ```
+3. Run the CLI:
+   ```bash
+   hatch run wic --vars /path/to/envfiledir --help
+   ```
+
 ### With bitbake
 1. Ensure you have bitbake available in your PATH.
 2. Install locally for development:
-- 
2.51.0



                 reply	other threads:[~2026-04-07 18:49 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260407184932.3466366-1-twoerner@gmail.com \
    --to=twoerner@gmail.com \
    --cc=yocto-patches@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.