From: Uladzimir Bely <ubely@ilbers.de>
To: isar-users@googlegroups.com
Subject: [PATCH v4 12/13] kas: Add kas/README.md
Date: Fri, 22 Sep 2023 11:10:02 +0200 [thread overview]
Message-ID: <20230922091003.20763-13-ubely@ilbers.de> (raw)
In-Reply-To: <20230922091003.20763-1-ubely@ilbers.de>
Add a brief description of `kas-container` usage.
Signed-off-by: Uladzimir Bely <ubely@ilbers.de>
---
README.md | 3 +++
kas/README.md | 36 ++++++++++++++++++++++++++++++++++++
2 files changed, 39 insertions(+)
create mode 100644 kas/README.md
diff --git a/README.md b/README.md
index 118acf52..f549aa9f 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,9 @@ https://github.com/ilbers/isar/
Instruction on how to build can be found in the [User Manual](doc/user_manual.md).
+For beginners, it could be easier to use kas-based approach that allows to
+simply configure and run build using menu. Look at [kas/README](kas/README.md)
+for the instructions.
# Try
diff --git a/kas/README.md b/kas/README.md
new file mode 100644
index 00000000..d821f0c8
--- /dev/null
+++ b/kas/README.md
@@ -0,0 +1,36 @@
+# Support of kas
+
+[kas](https://github.com/siemens/kas) is a tool to setup bitbake based projects.
+
+Directory `kas` contains required configuration fragments to setup and build
+Isar with `kas-container` script and Kconfig language.
+
+## Requirements
+
+Since kas uses Docker or Podman based containers, users that runs Isar build
+using `kas-container` script should be allowed to run these containers in
+privileged mode.
+
+## Configuring Isar build
+
+```
+./kas/kas-container menu
+```
+
+This creates `.config.yaml` file in isar root that stores the configuration.
+
+
+## Building Isar after configuration done
+
+```
+./kas/kas-container build
+```
+
+This generates `build/conf/` configuration and starts building Isar using
+kas container. Required image will be downloaded if not yet).
+
+To access bulid shell, the following command can be used:
+
+```
+./kas/kas-container shell
+```
--
2.20.1
next prev parent reply other threads:[~2023-09-22 9:10 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-22 9:09 [PATCH v4 00/13] Support building Isar using kas Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 01/13] kas: Add initial Kconfig support Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 02/13] kas: Add a local copy of kas-container script Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 03/13] kas: Add mirror selection Uladzimir Bely
2023-09-25 11:34 ` Jan Kiszka
2023-09-25 14:38 ` Uladzimir Bely
2023-09-25 14:49 ` Jan Kiszka
2023-09-26 7:59 ` Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 04/13] kas: Add packages selection Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 05/13] kas: Add COMPAT_ARCH support Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 06/13] kas: Add cross compilation mode selection support Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 07/13] kas: Add ccache option Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 08/13] kas: Add image type selection Uladzimir Bely
2023-09-22 9:09 ` [PATCH v4 09/13] kas: Add IMAGE_FSTYPES selection Uladzimir Bely
2023-09-22 9:10 ` [PATCH v4 10/13] kas: Support CACHE_DEB_SRC option in menu Uladzimir Bely
2023-09-22 9:10 ` [PATCH v4 11/13] kas: Add options to activate predefined users Uladzimir Bely
2023-09-22 9:10 ` Uladzimir Bely [this message]
2023-09-22 9:10 ` [PATCH v4 13/13] scripts: Add a script to generate kas yaml configs Uladzimir Bely
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=20230922091003.20763-13-ubely@ilbers.de \
--to=ubely@ilbers.de \
--cc=isar-users@googlegroups.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox