PTU5KAS/README.md
Claudius Heine 67ec7f3bfc Extended and converted user guide to ReST
Restructured text provide more options to extend the documentation by
including sphinx generated content.

Also added reference documentation for the static configuration format.

Signed-off-by: Claudius Heine <ch@denx.de>
2017-06-28 15:12:15 +02:00

36 lines
1.2 KiB
Markdown

Setup tool for bitbake based projects
=====================================
|Branch |Build Status|
|--------|------------|
|`master`|[![Build Status](https://travis-ci.org/siemens/kas.svg?branch=master)](https://travis-ci.org/siemens/kas)|
|`next` |[![Build Status](https://travis-ci.org/siemens/kas.svg?branch=next)](https://travis-ci.org/siemens/kas)|
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.
Currently supported Yocto versions:
- 2.1 (Krogoth)
- 2.2 (Morty)
Older or newer versions may work as well but haven't been tested intensively.
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
Guides
------
- [User guide](docs/userguide.rst)
- [Developer guide](docs/devguide.md)