[gnome-builder/wip/chergert/pipeline-merge: 64/76] doc: add OVERVIEW.md for buildconfig



commit 433aba2ee9aa442a554eb00f92475a640e1a7d82
Author: Christian Hergert <chergert redhat com>
Date:   Sat Feb 4 23:53:58 2017 -0800

    doc: add OVERVIEW.md for buildconfig

 libide/buildconfig/OVERVIEW.md |   27 +++++++++++++++++++++++++++
 1 files changed, 27 insertions(+), 0 deletions(-)
---
diff --git a/libide/buildconfig/OVERVIEW.md b/libide/buildconfig/OVERVIEW.md
new file mode 100644
index 0000000..9447d75
--- /dev/null
+++ b/libide/buildconfig/OVERVIEW.md
@@ -0,0 +1,27 @@
+# BuildConfig
+
+Once upon a time, Builder needed a simple format to track build configurations
+so that we could build projects and associate the proper SDK/Runtime, configure
+options, prefix, and other tweaks.
+
+The format for this file was called ".buildconfig" following in the footsteps
+of ".editorconfig" files.
+
+It looked something like:
+
+```
+[default]
+id = default
+default = true
+name = Default Configuration
+prefix = /app
+runtime = flatpak:org.gnome.Sdk
+device = local
+```
+
+However, as we grew the configuration engine, we allowed configuration backends
+so this format no longer became a requirement. Therefore, it was abstracted
+into the buildconfig embedded plugin.
+
+It continues to provide a simple configuration provider based on .buildconfig
+files.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]