public inbox for isar-users@googlegroups.com
 help / color / mirror / Atom feed
From: Uladzimir Bely <ubely@ilbers.de>
To: isar-users@googlegroups.com
Subject: [PATCH 13/13] kas: Add Readme.md
Date: Fri, 15 Sep 2023 08:44:26 +0200	[thread overview]
Message-ID: <20230915064426.27676-14-ubely@ilbers.de> (raw)
In-Reply-To: <20230915064426.27676-1-ubely@ilbers.de>

Add brief description of `kas-container` usage.

Signed-off-by: Uladzimir Bely <ubely@ilbers.de>
---
 kas/README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 kas/README.md

diff --git a/kas/README.md b/kas/README.md
new file mode 100644
index 00000000..780b0220
--- /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


  parent reply	other threads:[~2023-09-15  6:44 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-15  6:44 [PATCH 00/13] Support building Isar using kas Uladzimir Bely
2023-09-15  6:44 ` [PATCH 01/13] kas: Add initial Kconfig support Uladzimir Bely
2023-09-15  6:44 ` [PATCH 02/13] kas: Add a local copy of kas-container script Uladzimir Bely
2023-09-15  6:44 ` [PATCH 03/13] kas: Add dependencies between machine and distro configuration Uladzimir Bely
2023-09-16  9:34   ` Jan Kiszka
2023-09-19  6:30     ` Uladzimir Bely
2023-09-19  6:43       ` Jan Kiszka
2023-09-15  6:44 ` [PATCH 04/13] kas: Add mirror selection Uladzimir Bely
2023-09-16  9:34   ` Jan Kiszka
2023-09-19  6:31     ` Uladzimir Bely
2023-09-15  6:44 ` [PATCH 05/13] kas: Add packages selection Uladzimir Bely
2023-09-16  9:37   ` Jan Kiszka
2023-09-16 16:10     ` Jan Kiszka
2023-09-15  6:44 ` [PATCH 06/13] kas: Add COMPAT_ARCH support Uladzimir Bely
2023-09-15  6:44 ` [PATCH 07/13] kas: Add cross compilation mode selection support Uladzimir Bely
2023-09-15  6:44 ` [PATCH 08/13] kas: Add ccache option Uladzimir Bely
2023-09-15  6:44 ` [PATCH 09/13] kas: Add image type selection Uladzimir Bely
2023-09-16  9:57   ` Jan Kiszka
2023-09-19  6:32     ` Uladzimir Bely
2023-09-15  6:44 ` [PATCH 10/13] kas: Add IMAGE_FSTYPES selection Uladzimir Bely
2023-09-15  6:44 ` [PATCH 11/13] kas: Support CACHE_DEB_SRC option in menu Uladzimir Bely
2023-09-15  6:44 ` [PATCH 12/13] kas: Add options to activate predefined users Uladzimir Bely
2023-09-16  9:39   ` Jan Kiszka
2023-09-15  6:44 ` Uladzimir Bely [this message]
2023-09-16  9:40 ` [PATCH 00/13] Support building Isar using kas Jan Kiszka
2023-09-16 10:02   ` Jan Kiszka

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=20230915064426.27676-14-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