From 23e080b90d896cffe289ab194092b65662d73dee Mon Sep 17 00:00:00 2001 From: James Ennis <james.ennis@codethink.com> Date: Fri, 27 Jul 2018 10:03:56 +0100 Subject: [PATCH] README.md: Minor corrections --- README.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 6f64f47a6c..ef1de89da5 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. -- GitLab