Go to file
Henning Schild 243c51d24d Use issue template to point people to the list
We often see Issues being used while they maybe should not. Introducing
an issue template might help avoid confusion and inviting contributors
to the list without disabling Issues.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-03-25 19:43:01 +01:00
.github Use issue template to point people to the list 2021-03-25 19:43:01 +01:00
docs docs: Improve link to container images 2021-03-19 16:24:25 +01:00
kas Introduce KAS_BUILD_DIR environment variable 2021-03-10 07:53:09 +01:00
scripts checkcode: Address shellcheck warnings 2021-01-29 21:00:08 +01:00
tests Introduce KAS_BUILD_DIR environment variable 2021-03-10 07:53:09 +01:00
.dockerignore add dockerignore 2017-06-26 09:29:07 +02:00
.flake8 flake8: Ignore obsolete warning W503 2020-11-13 20:54:20 +01:00
.gitignore Add release artifact to .gitignore 2020-11-20 12:05:51 +01:00
CHANGELOG.md Release 2.4 2021-02-25 19:09:02 +01:00
container-entrypoint Add support for rootless podman with userns keep-id 2021-01-20 08:16:36 +01:00
CONTRIBUTING.md CONTRIBUTING: Drop reference to non-existing maintainer list 2020-12-17 18:13:19 +01:00
Dockerfile Dockerfile: do not allow pip to fetch any deps anymore 2021-02-24 20:54:06 +01:00
Dockerfile.isar ci: Push directly from build step 2021-01-03 18:39:12 +01:00
kas-container kas-container: Improve KAS_WORK/BUILD_DIR retrieval 2021-03-21 09:17:30 +01:00
kas-docker rename kas-docker to kas-container, leave symlink in place 2020-09-29 08:30:10 +02:00
LICENSE Correct grammar, spelling and copyright year in files 2018-09-05 12:46:35 +02:00
README.rst Switch to github workflow 2020-09-24 13:13:12 +02:00
requirements_rtd.txt requirements_rtd: Add jsonschema module 2020-06-02 10:36:54 +02:00
run-kas Correct grammar, spelling and copyright year in files 2018-09-05 12:46:35 +02:00
setup.py setup: Set upper version limit for dependencies 2021-02-24 09:01:08 +01:00

Setup tool for bitbake based projects
=====================================

+--------------------+
|    Build Status    |
+====================+
| |workflow-master|_ |
+--------------------+
| |workflow-next|_   |
+--------------------+

.. |workflow-master| image:: https://github.com/siemens/kas/workflows/master/badge.svg
.. _workflow-master: https://github.com/siemens/kas/actions?query=workflow%3Amaster
.. |workflow-next| image:: https://github.com/siemens/kas/workflows/next/badge.svg
.. _workflow-next: https://github.com/siemens/kas/actions?query=workflow%3Anext

This tool provides an easy mechanism to setup bitbake based
projects.

The OpenEmbedded tooling support starts at step 2 with bitbake. The
downloading of sources and then configuration has to be done by
hand. Usually, this is explained in a README. Instead kas is using a
project configuration file and does the download and configuration
phase.

Key features provided by the build tool:

- clone and checkout bitbake layers
- create default bitbake settings (machine, arch, ...)
- launch minimal build environment, reducing risk of host contamination
- initiate bitbake build process

See the `kas documentation <https://kas.readthedocs.io>`_ for further details.