Go to file
Jan Kiszka 122f7749a3 readthedocs: Add configuration file
Use the more powerful configuration file .readthedocs.yaml to ensure
that all requirements are installed. This now includes also a distro
package, python-newt, something that cannot be installed via a
requirements.txt.

Fixes the doc build for 2.6.x which become broken with the addition of
the menu plugin.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2021-11-22 19:20:14 +01:00
.github tests: Add basic tests for menu plugin 2021-10-09 15:02:22 +02:00
contrib Dockerfile: Carry oe-git-proxy locally 2021-08-30 21:56:04 +02:00
docs readthedocs: Add configuration file 2021-11-22 19:20:14 +01:00
kas Release 2.6.2 2021-11-02 13:01:21 +01:00
scripts checkcode: Address shellcheck warnings 2021-01-29 21:00:08 +01:00
tests for_all_repos: adapt test 2021-10-15 15:42:27 +02: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
.readthedocs.yaml readthedocs: Add configuration file 2021-11-22 19:20:14 +01:00
CHANGELOG.md Release 2.6.2 2021-11-02 13:01:21 +01:00
container-entrypoint kas-container: Add support for menu plugin 2021-10-09 15:00:05 +02:00
CONTRIBUTING.md CONTRIBUTING: Drop reference to non-existing maintainer list 2020-12-17 18:13:19 +01:00
Dockerfile Dockerfile: Drop world-write permission from /kas folder 2021-10-29 12:51:10 +02:00
Dockerfile.isar Dockerfile: install git-lfs from buster-backports. 2021-08-06 12:56:10 +02:00
kas-container kas-container: Add check for KAS_REPO_REF_DIR 2021-11-06 10:57:15 +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
run-kas Correct grammar, spelling and copyright year in files 2018-09-05 12:46:35 +02:00
setup.py setup: Drop include_package_data 2021-10-22 19:58:59 +02: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.