summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 000000000..eaeb54f4c
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,15 @@
+BuildStream is a flexible and extensible framework for the modelling of build
+and CI pipelines in a declarative YAML format, written in python.
+
+BuildStream defines a pipeline as abstract elements related by their dependencies,
+and stacks to conveniently group dependencies together. Basic element types for
+importing SDKs in the form of tarballs or ostree checkouts, building software
+components and exporting SDKs or deploying bootable filesystem images will be
+included in BuildStream, but it is expected that projects forge their own custom
+elements for doing more elaborate things such as running custom CI tests or deploying
+software in special ways.
+
+The build pipeline is a flow based concept which operates on filesystem data as
+input and output. An element's input is the sum of it's dependencies, sources and
+configuration loaded from the YAML, while the output is something on the filesystem
+which another element can then depend on.