Commit Graph

14 Commits

Author SHA1 Message Date
Jan Kiszka
a96197716b README: Remove reference to supported Yocto versions
Easy to get out of sync with duplicate info in docs/instro.rst.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2017-07-20 15:28:36 +02:00
Claudius Heine
30379f7bd7 README.md: Replaced documentation links to a readthedocs link
While the guides are available and renderd on github, there are many
things, that gar generated by sphinx, missing.

This patch replaces those links to one that points to the readthedocs
site.

Signed-off-by: Claudius Heine <ch@denx.de>
2017-06-29 08:49:03 +02:00
Claudius Heine
7ae7fcdb79 Extended and converted developer guide to ReST
In order to include sphinx generated documentation, restructured text
has to be used. Added some sphinx generated content.

Signed-off-by: Claudius Heine <ch@denx.de>
2017-06-28 15:12:15 +02:00
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
Claudius Heine
16f74a55a6 Moved documentation from README.md to sphinx documentation system
Signed-off-by: Claudius Heine <ch@denx.de>
2017-06-28 15:12:15 +02:00
Claudius Heine
a618ea95bd Fixes install instructions in README.md
Without period pip complains.

Also rather use `pip3` instead of `pip` because some distributions still
default to python 2 and pip for python 2.

Signed-off-by: Claudius Heine <ch@denx.de>
2017-06-23 08:36:28 +02:00
Daniel Mohr
f3cee3b296 ci: Add Travis build status batches to README
The batches also provide a link to the build
status on travis-ci.org

Signed-off-by: Daniel Mohr <daniel.mohr@evosoft.com>
2017-06-22 10:24:51 +02:00
Claudius Heine
7451b35f46 Updated Readme.md to include documentation about include mechanism
This patch updates the Readme.md to describe the include mechanism
and to use YAML instead of JSON.

Signed-off-by: Claudius Heine <ch@denx.de>
2017-06-21 17:30:51 +02:00
Claudius Heine
c950de46f9 Renamed sublayers back to layers
It was decided that 'sublayers' is to confusing, because this term is
not used in the bitbake/openembedded context.

Signed-off-by: Claudius Heine <ch@denx.de>
2017-06-21 17:30:51 +02:00
Claudius Heine
33a21c8d0d run pylint3 and fixed report
This commit adds a pylint configuration and fixed all found issues.

Signed-off-by: Claudius Heine <ch@denx.de>
2017-06-21 17:30:51 +02:00
Jan Kiszka
c65657cac6 Remove state tracking, use KAS_WORK_DIR env variable
Config.has_changed didn't work reliably so far, so the state cache was
only allowing to associate a work directory with configuration file.
However this was rather unintuitive, specifically when moving the work
dir to a different home - nothing told the user about the persistent
association.

We therefore agreed to remove the state cache for now. It can be
reintroduced at any time once a consistent usage model exists.

To establish a relationship to a work directory inside a shell session,
kas now evaluates the KAS_WORK_DIR environment variable.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2017-06-19 12:54:24 +02:00
Jan Kiszka
fe39f9f370 Massage README
* reorder to have most relevant information first
* adjust docker description
* improve consistency of examples
* add community resources

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2017-06-19 12:31:12 +02:00
Jan Kiszka
676ab2e541 Update PyYAML dependencies
We now need this extra package to run kas.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2017-06-15 10:07:13 +02:00
Daniel Wagner
daf0abab5e Initial public release
This is the first public release of kas.

Signed-off-by: Daniel Wagner <daniel.wagner@siemens.com>
2017-06-14 15:21:19 +02:00