Tristan Van Berkom pushed to branch tristan/docs-version-badge at BuildStream / buildstream
WARNING: The push did not contain any new commits, but force pushed to delete the commits and changes below.
Deleted commits:
-
0f5ecbdb
by Tristan Van Berkom at 2018-08-29T09:34:08Z
3 changed files:
Changes:
| ... | ... | @@ -14,82 +14,4 @@ About |
| 14 | 14 |
:target: https://gitlab.com/BuildStream/buildstream/commits/master
|
| 15 | 15 |
|
| 16 | 16 |
|
| 17 |
-What is BuildStream?
|
|
| 18 |
-====================
|
|
| 19 |
-BuildStream is a Free Software tool for building/integrating software stacks.
|
|
| 20 |
-It takes inspiration, lessons and use-cases from various projects including
|
|
| 21 |
-OBS, Reproducible Builds, Yocto, Baserock, Buildroot, Aboriginal, GNOME Continuous,
|
|
| 22 |
-JHBuild, Flatpak Builder and Android repo.
|
|
| 23 |
- |
|
| 24 |
-BuildStream supports multiple build-systems (e.g. autotools, cmake, cpan, distutils,
|
|
| 25 |
-make, meson, qmake), and can create outputs in a range of formats (e.g. debian packages,
|
|
| 26 |
-flatpak runtimes, sysroots, system images) for multiple platforms and chipsets.
|
|
| 27 |
- |
|
| 28 |
- |
|
| 29 |
-Why should I use BuildStream?
|
|
| 30 |
-=============================
|
|
| 31 |
-BuildStream offers the following advantages:
|
|
| 32 |
- |
|
| 33 |
-* **Declarative build instructions/definitions**
|
|
| 34 |
- |
|
| 35 |
- BuildStream provides a flexible and extensible framework for the modelling
|
|
| 36 |
- of software build pipelines in a declarative YAML format, which allows you to
|
|
| 37 |
- manipulate filesystem data in a controlled, reproducible sandboxed environment.
|
|
| 38 |
- |
|
| 39 |
-* **Support for developer and integrator workflows**
|
|
| 40 |
- |
|
| 41 |
- BuildStream provides traceability and reproducibility for integrators handling
|
|
| 42 |
- stacks of hundreds/thousands of components, as well as workspace features and
|
|
| 43 |
- shortcuts to minimise cycle-time for developers.
|
|
| 44 |
- |
|
| 45 |
-* **Fast and predictable**
|
|
| 46 |
- |
|
| 47 |
- BuildStream can cache previous builds and track changes to source file content
|
|
| 48 |
- and build/config commands. BuildStream only rebuilds the things that have changed.
|
|
| 49 |
- |
|
| 50 |
-* **Extensible**
|
|
| 51 |
- |
|
| 52 |
- You can extend BuildStream to support your favourite build-system.
|
|
| 53 |
- |
|
| 54 |
-* **Bootstrap toolchains and bootable systems**
|
|
| 55 |
- |
|
| 56 |
- BuildStream can create full systems and complete toolchains from scratch, for
|
|
| 57 |
- a range of ISAs including x86_32, x86_64, ARMv7, ARMv8, MIPS.
|
|
| 58 |
- |
|
| 59 |
- |
|
| 60 |
-How do I use BuildStream?
|
|
| 61 |
-=========================
|
|
| 62 |
-Please refer to the `documentation <https://buildstream.gitlab.io/buildstream/>`_
|
|
| 63 |
-for information about installing BuildStream, and about the BuildStream YAML format
|
|
| 64 |
-and plugin options.
|
|
| 65 |
- |
|
| 66 |
- |
|
| 67 |
-How does BuildStream work?
|
|
| 68 |
-==========================
|
|
| 69 |
-BuildStream operates on a set of YAML files (.bst files), as follows:
|
|
| 70 |
- |
|
| 71 |
-* Loads the YAML files which describe the target(s) and all dependencies.
|
|
| 72 |
-* Evaluates the version information and build instructions to calculate a build
|
|
| 73 |
- graph for the target(s) and all dependencies and unique cache-keys for each
|
|
| 74 |
- element.
|
|
| 75 |
-* Retrieves previously built elements (artifacts) from a local/remote cache, or
|
|
| 76 |
- builds the elements in a sandboxed environment using the instructions declared
|
|
| 77 |
- in the .bst files.
|
|
| 78 |
-* Transforms/configures and/or deploys the resulting target(s) based on the
|
|
| 79 |
- instructions declared in the .bst files.
|
|
| 80 |
- |
|
| 81 |
- |
|
| 82 |
-How can I get started?
|
|
| 83 |
-======================
|
|
| 84 |
-To get started, first `install BuildStream by following the installation guide
|
|
| 85 |
-<https://buildstream.gitlab.io/buildstream/main_install.html>`_
|
|
| 86 |
-and then follow our tutorial in the
|
|
| 87 |
-`user guide <https://buildstream.gitlab.io/buildstream/main_using.html>`_.
|
|
| 88 |
- |
|
| 89 |
-We also recommend exploring some existing BuildStream projects:
|
|
| 90 |
- |
|
| 91 |
-* https://gitlab.gnome.org/GNOME/gnome-build-meta/
|
|
| 92 |
-* https://gitlab.com/freedesktop-sdk/freedesktop-sdk
|
|
| 93 |
-* https://gitlab.com/baserock/definitions
|
|
| 94 |
- |
|
| 95 |
-If you have any questions please ask on our `#buildstream <irc://irc.gnome.org/buildstream>`_ channel in `irc.gnome.org <irc://irc.gnome.org>`_
|
|
| 17 |
+.. include:: doc/source/main_about_content.rst
|
| 1 |
-.. include:: ../../README.rst
|
|
| 1 |
+About
|
|
| 2 |
+-----
|
|
| 3 |
+ |
|
| 4 |
+.. include:: release-badge.rst
|
|
| 5 |
+ |
|
| 6 |
+.. include:: snapshot-badge.rst
|
|
| 7 |
+ |
|
| 8 |
+.. image:: https://gitlab.com/BuildStream/buildstream/badges/master/pipeline.svg
|
|
| 9 |
+ :target: https://gitlab.com/BuildStream/buildstream/commits/master
|
|
| 10 |
+ |
|
| 11 |
+.. image:: https://gitlab.com/BuildStream/buildstream/badges/master/coverage.svg?job=coverage
|
|
| 12 |
+ :target: https://gitlab.com/BuildStream/buildstream/commits/master
|
|
| 13 |
+ |
|
| 14 |
+ |
|
| 15 |
+.. include:: main_about_content.rst
|
| 1 |
+ |
|
| 2 |
+What is BuildStream?
|
|
| 3 |
+====================
|
|
| 4 |
+BuildStream is a Free Software tool for building/integrating software stacks.
|
|
| 5 |
+It takes inspiration, lessons and use-cases from various projects including
|
|
| 6 |
+OBS, Reproducible Builds, Yocto, Baserock, Buildroot, Aboriginal, GNOME Continuous,
|
|
| 7 |
+JHBuild, Flatpak Builder and Android repo.
|
|
| 8 |
+ |
|
| 9 |
+BuildStream supports multiple build-systems (e.g. autotools, cmake, cpan, distutils,
|
|
| 10 |
+make, meson, qmake), and can create outputs in a range of formats (e.g. debian packages,
|
|
| 11 |
+flatpak runtimes, sysroots, system images) for multiple platforms and chipsets.
|
|
| 12 |
+ |
|
| 13 |
+ |
|
| 14 |
+Why should I use BuildStream?
|
|
| 15 |
+=============================
|
|
| 16 |
+BuildStream offers the following advantages:
|
|
| 17 |
+ |
|
| 18 |
+* **Declarative build instructions/definitions**
|
|
| 19 |
+ |
|
| 20 |
+ BuildStream provides a flexible and extensible framework for the modelling
|
|
| 21 |
+ of software build pipelines in a declarative YAML format, which allows you to
|
|
| 22 |
+ manipulate filesystem data in a controlled, reproducible sandboxed environment.
|
|
| 23 |
+ |
|
| 24 |
+* **Support for developer and integrator workflows**
|
|
| 25 |
+ |
|
| 26 |
+ BuildStream provides traceability and reproducibility for integrators handling
|
|
| 27 |
+ stacks of hundreds/thousands of components, as well as workspace features and
|
|
| 28 |
+ shortcuts to minimise cycle-time for developers.
|
|
| 29 |
+ |
|
| 30 |
+* **Fast and predictable**
|
|
| 31 |
+ |
|
| 32 |
+ BuildStream can cache previous builds and track changes to source file content
|
|
| 33 |
+ and build/config commands. BuildStream only rebuilds the things that have changed.
|
|
| 34 |
+ |
|
| 35 |
+* **Extensible**
|
|
| 36 |
+ |
|
| 37 |
+ You can extend BuildStream to support your favourite build-system.
|
|
| 38 |
+ |
|
| 39 |
+* **Bootstrap toolchains and bootable systems**
|
|
| 40 |
+ |
|
| 41 |
+ BuildStream can create full systems and complete toolchains from scratch, for
|
|
| 42 |
+ a range of ISAs including x86_32, x86_64, ARMv7, ARMv8, MIPS.
|
|
| 43 |
+ |
|
| 44 |
+ |
|
| 45 |
+How do I use BuildStream?
|
|
| 46 |
+=========================
|
|
| 47 |
+Please refer to the `documentation <https://buildstream.gitlab.io/buildstream/>`_
|
|
| 48 |
+for information about installing BuildStream, and about the BuildStream YAML format
|
|
| 49 |
+and plugin options.
|
|
| 50 |
+ |
|
| 51 |
+ |
|
| 52 |
+How does BuildStream work?
|
|
| 53 |
+==========================
|
|
| 54 |
+BuildStream operates on a set of YAML files (.bst files), as follows:
|
|
| 55 |
+ |
|
| 56 |
+* Loads the YAML files which describe the target(s) and all dependencies.
|
|
| 57 |
+* Evaluates the version information and build instructions to calculate a build
|
|
| 58 |
+ graph for the target(s) and all dependencies and unique cache-keys for each
|
|
| 59 |
+ element.
|
|
| 60 |
+* Retrieves previously built elements (artifacts) from a local/remote cache, or
|
|
| 61 |
+ builds the elements in a sandboxed environment using the instructions declared
|
|
| 62 |
+ in the .bst files.
|
|
| 63 |
+* Transforms/configures and/or deploys the resulting target(s) based on the
|
|
| 64 |
+ instructions declared in the .bst files.
|
|
| 65 |
+ |
|
| 66 |
+ |
|
| 67 |
+How can I get started?
|
|
| 68 |
+======================
|
|
| 69 |
+To get started, first `install BuildStream by following the installation guide
|
|
| 70 |
+<https://buildstream.gitlab.io/buildstream/main_install.html>`_
|
|
| 71 |
+and then follow our tutorial in the
|
|
| 72 |
+`user guide <https://buildstream.gitlab.io/buildstream/main_using.html>`_.
|
|
| 73 |
+ |
|
| 74 |
+We also recommend exploring some existing BuildStream projects:
|
|
| 75 |
+ |
|
| 76 |
+* https://gitlab.gnome.org/GNOME/gnome-build-meta/
|
|
| 77 |
+* https://gitlab.com/freedesktop-sdk/freedesktop-sdk
|
|
| 78 |
+* https://gitlab.com/baserock/definitions
|
|
| 79 |
+ |
|
| 80 |
+If you have any questions please ask on our `#buildstream <irc://irc.gnome.org/buildstream>`_ channel in `irc.gnome.org <irc://irc.gnome.org>`_
|