aboutsummaryrefslogtreecommitdiffstats
path: root/config/README
diff options
context:
space:
mode:
Diffstat (limited to 'config/README')
-rw-r--r--config/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/config/README b/config/README
new file mode 100644
index 00000000..11512f46
--- /dev/null
+++ b/config/README
@@ -0,0 +1,21 @@
+CCNx Distillery Config Directory
+
+This is the directory where CCNx Distillery stores it's configuration
+information. Most configuration is parsed by makefile so the files are in
+makefile format.
+
+Important files and directories
+
+# config.mk
+This is the default configuration. DO NOT CHANGE THIS FILE. You can use this
+file as a template to create your own configuration.
+
+# modules
+This is the modules directory. It has the configuration file for each module
+that is available through Distillery.
+
+# local
+This directory (may or may not exist) is the place to put your local
+configuration files. It gets ignored by git. Make will look for a
+configuration file called config.mk in this directory to configure this
+specific instance of Distillery.