summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-04-18 12:25:30 +0100
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-04-18 12:25:30 +0100
commitc3548c774a12a1e7affbd31e3ac22bddc767a45a (patch)
treebd5347121e4cabdb51d842db66b9afa8fc26a31d /README.rst
parentdc156f040561fc16554a2be919f2f25be5c27574 (diff)
downloadbuildstream-c3548c774a12a1e7affbd31e3ac22bddc767a45a.tar.gz
README.rst: Adjusted text and link to documentation
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst27
1 files changed, 14 insertions, 13 deletions
diff --git a/README.rst b/README.rst
index 43cbaf7c7..f80507d33 100644
--- a/README.rst
+++ b/README.rst
@@ -1,18 +1,19 @@
BuildStream
===========
-
BuildStream is a flexible and extensible framework for the modelling of build
-and CI pipelines in a declarative YAML format, written in python.
+pipelines in a declarative YAML format, written in python.
+
+These pipelines are composed of abstract elements which perform mutations on
+on *filesystem data* as input and output, and are related to eachother by their
+dependencies.
-BuildStream defines a pipeline as abstract elements related by their dependencies,
-and stacks to conveniently group dependencies together. Basic element types for
-importing SDKs in the form of tarballs or ostree checkouts, building software
-components and exporting SDKs or deploying bootable filesystem images will be
-included in BuildStream, but it is expected that projects forge their own custom
-elements for doing more elaborate things such as running custom CI tests or deploying
-software in special ways.
+Basic element types for importing SDKs in the form of tarballs or ostree checkouts,
+building software components and exporting SDKs or deploying bootable filesystem images
+will be included in BuildStream, but it is expected that projects forge their own custom
+elements for doing more elaborate things such as deploying software in special ways.
-The build pipeline is a flow based concept which operates on filesystem data as
-input and output. An element's input is the sum of its dependencies, sources and
-configuration loaded from the YAML, while the output is something on the filesystem
-which another element can then depend on.
+Documentation
+-------------
+Please refer to the `complete documentation <https://buildstream.gitlab.io/buildstream/>`_
+for more information about installing BuildStream, and about the BuildStream YAML format
+and plugin options.