summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst23
1 files changed, 16 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index df1f72f1a..c45568731 100644
--- a/README.rst
+++ b/README.rst
@@ -6,11 +6,20 @@ BuildStream
What is BuildStream?
====================
-BuildStream is an Free Software tool for building/integrating software stacks.
-It supports multiple build-systems (e.g. autotools, cmake, cpan, distutils, make,
-meson, qmake), covers many programming languages, and can create outputs in a
+BuildStream is a Free Software tool for building/integrating software stacks.
+It takes inspiration, lessons and use-cases from various projects including
+OBS, Reproducible Builds, Yocto, Baserock, Buildroot, Aboriginal, GNOME Continuous,
+JHBuild, Flatpak Builder and Android repo.
+
+BuildStream supports multiple build-systems (e.g. autotools, cmake, cpan, distutils,
+make, meson, qmake), covers many programming languages, and can create outputs in a
range of packaging formats, for multiple platforms and chipsets.
+Buildstream is designed to build, integrate and deploy software stacks in pipelines,
+for example:
+
+.. image:: ./doc/images/buildstream-pipeline.png
+
Why should I use BuildStream?
=============================
@@ -58,10 +67,10 @@ BuildStream operates on a set of YAML files (.bst files), as follows:
* evaluates the version information and build instructions to calculate a build
graph for the target(s) and all dependencies and unique cache-keys for each
element
-* retrieves elements from cache if they are already built, or builds them using
- the instructions declared in the .bst files
-* transforms and/or deploys the resulting target(s) based on the instructions
- declared in the .bst files.
+* retrieves elements from cache if they are already built, or builds them in a
+ sandboxed environment using the instructions declared in the .bst files
+* transforms/configures and/or deploys the resulting target(s) based on the
+ instructions declared in the .bst files.
How can I get started?
======================