SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork of https://github.com/siemens/kas.git
386 Commits 1 Branch 0 Tags 806 KiB
Python 85%
Shell 12.9%
Dockerfile 2.1%
4e153a2872
Go to file
Paul Barker 4e153a2872 plugins: Improve documentation of existing modules 
The docstrings for the build and shell plugins are extended so that they
clearly describe each plugin and give brief examples of their use.

Also fix a typo in the build command help message.

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2020-11-13 07:45:07 +01:00
.github/workflows Switch to github workflow 2020-09-24 13:13:12 +02:00
docs plugins: Improve documentation of existing modules 2020-11-13 07:45:07 +01:00
kas plugins: Improve documentation of existing modules 2020-11-13 07:45:07 +01:00
scripts kas-container: make container image variables overwritable 2020-09-29 08:35:04 +02:00
tests tests: small correction to git args 2020-11-09 08:57:04 +01:00
.dockerignore add dockerignore 2017-06-26 09:29:07 +02:00
.flake8 Add flake8 config 2020-06-17 07:59:51 +02:00
.gitignore Expanded and documented .gitignore 2017-06-28 15:12:15 +02:00
CHANGELOG.md Release 2.2 2020-08-20 09:17:34 +02:00
container-entrypoint rename docker-entrypoint to container-entrypoint 2020-09-29 08:32:57 +02:00
CONTRIBUTING.md CONTRIBUTING: add subscription links for list to document 2018-12-17 10:58:33 +01:00
Dockerfile Dockerfile: add zstd 2020-11-02 09:10:37 +01:00
Dockerfile.isar rename docker-entrypoint to container-entrypoint 2020-09-29 08:32:57 +02:00
kas-container kas-container: allow the -d/-v of kas-container to set -d on kas 2020-10-22 08:40:37 +02: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 Drop Python 3.4 compatibility, include 3.8 2020-01-09 11:35:40 +01:00

README.rst 

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.