diff options
author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-04-18 12:25:43 +0100 |
---|---|---|
committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-04-18 12:25:43 +0100 |
commit | 3c2fcafa41a115841fae72245f19c92b07f52c42 (patch) | |
tree | fc163b6070e40e0a74989d420b19a78fadd72eef /doc/source/index.rst | |
parent | c3548c774a12a1e7affbd31e3ac22bddc767a45a (diff) | |
download | buildstream-3c2fcafa41a115841fae72245f19c92b07f52c42.tar.gz |
Documentation: Created "Installing BuildStream" Section
Included pedro's docker documentation at the end of this, as
an alternative for those who cannot obtain the base system
requirements to use BuildStream.
Diffstat (limited to 'doc/source/index.rst')
-rw-r--r-- | doc/source/index.rst | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 178dc06be..fe6bf693c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,21 +14,23 @@ About BuildStream BuildStream is a flexible and extensible framework for the modelling of build pipelines in a declarative YAML format, written in python. -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 +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. + +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. Using BuildStream ================= -Here are some resources to help you get off the ground when creating your very -first BuildStream project. +Here are some resources to help understand the BuildStream format and also to get +off the ground installing it on a new host. +* :ref:`installing` * :ref:`format` -* :ref:`docker` Elements |