From 4f5cd3ca5b9b642363c33a4876fa18eef42780af Mon Sep 17 00:00:00 2001 From: Jan Kiszka Date: Mon, 17 Jul 2017 22:38:02 +0200 Subject: [PATCH] README: Convert to structured text This is a preferred format of Python READMEs and also properly rendered by github. Signed-off-by: Jan Kiszka --- README.md => README.rst | 19 +++++++++++++------ setup.py | 2 +- 2 files changed, 14 insertions(+), 7 deletions(-) rename README.md => README.rst (52%) diff --git a/README.md b/README.rst similarity index 52% rename from README.md rename to README.rst index 268f689..24b1b13 100644 --- a/README.md +++ b/README.rst @@ -1,11 +1,18 @@ 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)| ++------------+------------------+ +| Branch | Build Status | ++============+==================+ +| ``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 projects. @@ -17,10 +24,10 @@ 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 - -[Documentation](https://kas.readthedocs.io) +See the `kas documentation `_ for further details. diff --git a/setup.py b/setup.py index dd410df..e2e8e19 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ __license__ = 'MIT' __copyright__ = 'Copyright (c) Siemens AG, 2017' 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()