Commit ccb3cee3 authored by Chandan Singh's avatar Chandan Singh

Merge branch 'chandan/buildstream-docs' into 'master'

Add documentation for buildstream/buildstream image

Closes #12

See merge request !108
parents 97430b86 88d2948b
Pipeline #47942013 passed with stages
in 266 minutes and 54 seconds
......@@ -10,13 +10,16 @@ The following sections will provide a list of images that are generated by
this repository.
buildstream/buildstream-fedora
------------------------------
buildstream/buildstream
-----------------------
This is the primary user-facing image that provides BuildStream, and all its
dependencies. If you are interested in running BuildStream inside Docker, this
is the image you will want to use.
This image comes in several variants, please see the
[documentation](buildstream/README.md) for this image for details about them.
For detailed instructions on using BuildStream with Docker, please see the
[BuildStream manual][bst-docker-install].
......@@ -28,6 +31,15 @@ macOS and Windows users to conveniently run BuildStream in a minimal Linux
container.
buildstream/buildstream-fedora
------------------------------
***This image is now DEPRECATED, and will be decomissioned soon.***
If you are using this image, please switch to using `buildstream/buildstream`
image instead. It should be a drop-in replacement for almost all use-cases.
buildsteam/artifact-cache
-------------------------
......
Published tags and respective `Dockerfile` links
------------------------------------------------
* `latest` ([latest.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/latest.Dockerfile))
* `dev` ([dev.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/dev.Dockerfile))
* `nightly` ([nightly.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/nightly.Dockerfile))
* `latest-slim` ([latest-slim.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/latest-slim.Dockerfile))
* `dev-slim` ([dev-slim.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/dev-slim.Dockerfile))
* `nightly-slim` ([nightly-slim.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/nightly-slim.Dockerfile))
* `latest-extra` ([latest-extra.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/latest-extra.Dockerfile))
* `dev-extra` ([dev-extra.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/dev-extra.Dockerfile))
* `nightly-extra` ([nightly-extra.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/nightly-extra.Dockerfile))
Supported Platforms
-------------------
Each of the above tags are supported on the following platforms:
* Linux - `x86_64`
* Linux - `aarch64`
What is BuildStream
-------------------
BuildStream is a Free Software tool for integrating software stacks.
It takes inspiration, lessons and use-cases from various projects including
Bazel, 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, pip) through its core plugins. External plugins
allow the creation of a range of output formats (e.g. debian packages, flatpak
runtimes, system images) for multiple platforms and chipsets.
[https://buildstream.build]()
[BuildStream Documentation](https://docs.buildstream.build/)
How to use this image
---------------------
For detailed instructions on how to use BuildStream via Docker, see
[BuildStream inside Docker](https://buildstream.build/docker_install.html)
documentation.
Image Variants
--------------
The `buildstream/buildstream` image comes in many flavors, each designed for
a specific use-case. All of the following tags are rebuilt on a daily basis.
* `latest`: This tag tracks the latest stable release of BuildStream. It will
also contain the system base dependencies of all the Core plugins of
BuildStream.
* `dev`: This tag tracks the latest development snapshot of BuildStream.
It will also contain the system base dependencies of all the Core plugins of
BuildStream.
* `nightly`: This tag tracks the master branch of BuildStream. It will also
contain the system base dependencies of all the Core plugins of BuildStream.
* `latest-slim`: Similar to `latest`, except that it does not contain the
dependencies of any plugins.
* `dev-slim`: Similar to `dev`, except that it does not contain the
system base dependencies of any plugins.
* `nightly-slim`: Similar to `nightly`, except that it does not contain the
system base dependencies of any plugins.
* `latest-extra`: Similar to `latest`, but it also contains external plugins
and their system base dependencies.
* `dev-extra`: Similar to `dev`, but it also contains external plugins
and their system base dependencies.
* `nightly-extra`: Similar to `nightly`, but it also contains external plugins
and their system base dependencies.
Where to raise issues
---------------------
This image is generated by the
[buildstream/buildstream-docker-images](https://gitlab.com/BuildStream/buildstream-docker-images)
project on GitLab. Merge requests and issue reports for the image itself should
be filed against that project.
Issue reports for BuildStream itself should be filed against the
[buildstream/buildstream](https://gitlab.com/BuildStream/buildstream) project
on GitLab.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment