diff options
| author | Javier Jardón <jjardon@gnome.org> | 2018-07-27 11:54:20 +0000 |
|---|---|---|
| committer | Javier Jardón <jjardon@gnome.org> | 2018-07-27 11:54:20 +0000 |
| commit | 6ea97b17c8947f69ca713f20c5bb5bf957fdf371 (patch) | |
| tree | d31f7c22ec448f529a1d1beb3b30077b741c4b35 | |
| parent | 48916b8a493eec873421d3b867515fb829d1faf8 (diff) | |
| parent | 2b93574e6c3093a603452273008057642939619a (diff) | |
| download | buildstream-438-migrate-x86-image-example-from-examples-repo-to-main-repo.tar.gz | |
Merge branch 'jennis/doc_improvements' into 'master'438-migrate-x86-image-example-from-examples-repo-to-main-repo
Refer readers to our tutorial before referring them to existing bst projects
See merge request BuildStream/buildstream!578
| -rw-r--r-- | README.rst | 24 | ||||
| -rw-r--r-- | doc/source/main_install.rst | 7 |
2 files changed, 20 insertions, 11 deletions
diff --git a/README.rst b/README.rst index 6f64f47a6..c553da068 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,25 +61,29 @@ 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. How can I get started? ====================== -The easiest way to get started is to explore some existing .bst files, for example: +To start using BuildStream, first, +`install <https://buildstream.gitlab.io/buildstream/main_install.html>`_ +BuildStream onto your machine and then follow our +`tutorial <https://buildstream.gitlab.io/buildstream/using_tutorial.html>`_. + +We also recommend exploring some existing BuildStream projects: * https://gitlab.gnome.org/GNOME/gnome-build-meta/ * https://gitlab.com/freedesktop-sdk/freedesktop-sdk * https://gitlab.com/baserock/definitions -* https://gitlab.com/BuildStream/buildstream-examples/tree/master/build-x86image -* https://gitlab.com/BuildStream/buildstream-examples/tree/master/netsurf-flatpak If you have any questions please ask on our `#buildstream <irc://irc.gnome.org/buildstream>`_ channel in `irc.gnome.org <irc://irc.gnome.org>`_ diff --git a/doc/source/main_install.rst b/doc/source/main_install.rst index ebd55a31e..1a4895903 100644 --- a/doc/source/main_install.rst +++ b/doc/source/main_install.rst @@ -1,7 +1,12 @@ Install ======= -This section covers how to install BuildStream onto your machine, how to run BuildStream inside a docker image and also how to configure an artifact server. +This section covers how to install BuildStream onto your machine, how to run +BuildStream inside a docker image and also how to configure an artifact server. +.. note:: + + BuildStream is not currently supported natively on macOS and Windows. Windows + and macOS users should refer to :ref:`docker`. .. toctree:: :maxdepth: 2 |