..
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.


.. _examples:

Examples
========
This page contains documentation for real examples of BuildStream projects,
described step by step. All run under CI, so you can trust they are
maintained and work as expected.


.. toctree::
   :maxdepth: 1

   examples/tar-mirror
   examples/git-mirror