README: Convert to structured text

This is a preferred format of Python READMEs and also properly rendered
by github.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Jan Kiszka 2017-07-17 22:38:02 +02:00 committed by Daniel Wagner
parent a96197716b
commit 4f5cd3ca5b
2 changed files with 14 additions and 7 deletions

View File

@ -1,11 +1,18 @@
Setup tool for bitbake based projects Setup tool for bitbake based projects
===================================== =====================================
|Branch |Build Status| +------------+------------------+
|--------|------------| | 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)| | ``master`` | |travis-master|_ |
+------------+------------------+
| ``next`` | |travis-next|_ |
+------------+------------------+
.. |travis-master| image:: https://travis-ci.org/siemens/kas.svg?branch=master
.. _travis-master: https://travis-ci.org/siemens/kas/branches
.. |travis-next| image:: https://travis-ci.org/siemens/kas.svg?branch=next
.. _travis-next: https://travis-ci.org/siemens/kas/branches
This tool provides an easy mechanism to setup bitbake based This tool provides an easy mechanism to setup bitbake based
projects. projects.
@ -17,10 +24,10 @@ project configuration file and does the download and configuration
phase. phase.
Key features provided by the build tool: Key features provided by the build tool:
- clone and checkout bitbake layers - clone and checkout bitbake layers
- create default bitbake settings (machine, arch, ...) - create default bitbake settings (machine, arch, ...)
- launch minimal build environment, reducing risk of host contamination - launch minimal build environment, reducing risk of host contamination
- initiate bitbake build process - initiate bitbake build process
See the `kas documentation <https://kas.readthedocs.io>`_ for further details.
[Documentation](https://kas.readthedocs.io)

View File

@ -32,7 +32,7 @@ __license__ = 'MIT'
__copyright__ = 'Copyright (c) Siemens AG, 2017' __copyright__ = 'Copyright (c) Siemens AG, 2017'
HERE = path.abspath(path.dirname(__file__)) HERE = path.abspath(path.dirname(__file__))
with open(path.join(HERE, 'README.md')) as f: with open(path.join(HERE, 'README.rst')) as f:
LONG_DESCRIPTION = f.read() LONG_DESCRIPTION = f.read()