Add build files

[rbdr/Flat-Bezel.qsplugin] / README.md

diff --git a/README.md b/README.md
index b8e9d5e0c6ed85080142a49c2f3609cdfc044846..e70058bdffb9ce808e66f6b8e7302fe9fcc94c8a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,3 +5,17 @@
 Pre-alpha development.
 
 A new take on the Bezel Interface, using a flatter look.
+
+## Building
+
+For easy CLI build you can run `make`. The default configuration is `Debug`,
+but you can change the configuration by running `make -e configuration=Release`.
+
+This assumes quicksilver is checked out in `../../vendor/Quicksilver`, but this
+value can be updated with the `quicksilver_path` variable (eg.
+`make -e quicksilver_path=../Quicksilver`).
+
+## Building for release
+
+To build for release you will have to set the environment variable
+`$SIGNING_IDENTITY`, otherwise it won't be correctly signed