summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Sherwood <paul.sherwood@codethink.co.uk>2018-04-17 09:31:47 +0100
committerPaul Sherwood <paul.sherwood@codethink.co.uk>2018-04-17 11:34:29 +0100
commit14ce545e19713cee953079c6bc6717117ac15902 (patch)
tree3cb7131519d78df33b8d7e50133de8b90cb22762
parent548c03f58b878fe685933e6e4d8209e80d37b8f5 (diff)
downloadbuildstream-ps-add-diagram.tar.gz
Fix typo, mention inspiration projects, add diagramps-add-diagram
-rw-r--r--README.rst23
-rw-r--r--build-bootstrap-cropped-1.pngbin0 -> 118163 bytes
-rw-r--r--doc/image-sources/buildstream-pipeline.odgbin0 -> 19838 bytes
-rw-r--r--doc/images/buildstream-pipeline.pngbin0 -> 349731 bytes
4 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?
======================
diff --git a/build-bootstrap-cropped-1.png b/build-bootstrap-cropped-1.png
new file mode 100644
index 000000000..f5b2cdf8a
--- /dev/null
+++ b/build-bootstrap-cropped-1.png
Binary files differ
diff --git a/doc/image-sources/buildstream-pipeline.odg b/doc/image-sources/buildstream-pipeline.odg
new file mode 100644
index 000000000..0c7ded981
--- /dev/null
+++ b/doc/image-sources/buildstream-pipeline.odg
Binary files differ
diff --git a/doc/images/buildstream-pipeline.png b/doc/images/buildstream-pipeline.png
new file mode 100644
index 000000000..23050eeda
--- /dev/null
+++ b/doc/images/buildstream-pipeline.png
Binary files differ