Commit 88d2948b authored by Chandan Singh's avatar Chandan Singh

README.md: Add description for buildsteam/buildstream

Add description for the newly added `buildstream/buildstream` image, and
mark the old `buildsteam/buildstream-fedora` image as deprecated.

This gets us one step closer to finishing #26.
parent 4ca627f5
Pipeline #47489848 passed with stages
in 150 minutes and 9 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
-------------------------
......
Supported tags and respective `Dockerfile` links
Published tags and respective `Dockerfile` links
------------------------------------------------
* `latest` ([latest.Dockerfile](https://gitlab.com/BuildStream/buildstream-docker-images/blob/master/buildstream/latest.Dockerfile))
......@@ -55,34 +55,33 @@ 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.
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.
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.
contain the system base dependencies of all the Core plugins of BuildStream.
* `latest-slim`: Similar to `latest`, except that it does not contain the
system base dependencies of any plugins.
dependencies of any plugins.
* `dev-slim`: Similar to `dev`, except that it does not contain the
system base dependencies of any plugins.
system base dependencies of any plugins.
* `nightly-slim`: Similar to `nightly`, except that it does not contain the
system base dependencies of any plugins.
system base dependencies of any plugins.
* `latest-extra`: Similar to `latest`, but it also contains external plugins
and their system base dependencies.
and their system base dependencies.
* `dev-extra`: Similar to `dev`, but it also contains external plugins
and their system base dependencies.
and their system base dependencies.
* `nightly-extra`: Similar to `nightly`, but it also contains external plugins
and their system base dependencies.
and their system base dependencies.
Where to raise issues
......
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