summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2018-07-27 10:03:56 +0100
committerJavier Jardón <jjardon@gnome.org>2018-07-27 11:13:50 +0000
commit23e080b90d896cffe289ab194092b65662d73dee (patch)
treedbc76395997b9ea03e1e848fca4ae6364a8a560a /README.rst
parent48916b8a493eec873421d3b867515fb829d1faf8 (diff)
downloadbuildstream-23e080b90d896cffe289ab194092b65662d73dee.tar.gz
README.md: Minor corrections
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 6f64f47a6..ef1de89da 100644
--- a/README.rst
+++ b/README.rst
@@ -25,7 +25,7 @@ BuildStream offers the following advantages:
* **Declarative build instructions/definitions**
- BuildStream provides a a flexible and extensible framework for the modelling
+ BuildStream provides a flexible and extensible framework for the modelling
of software build pipelines in a declarative YAML format, which allows you to
manipulate filesystem data in a controlled, reproducible sandboxed environment.
@@ -61,13 +61,14 @@ How does BuildStream work?
==========================
BuildStream operates on a set of YAML files (.bst files), as follows:
-* loads the YAML files which describe the target(s) and all dependencies
-* evaluates the version information and build instructions to calculate a build
+* Loads the YAML files which describe the target(s) and all dependencies.
+* 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 in a
- sandboxed environment using the instructions declared in the .bst files
-* transforms/configures and/or deploys the resulting target(s) based on the
+ element.
+* Retrieves previously built elements (artifacts) from a local/remote cache, or
+ builds the elements 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.