From 45f490c67758d08d7092e296e7b12cd80904e741 Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Thu, 11 May 2017 10:36:45 -0500 Subject: [PATCH] Clarification in the README around service vs. project configuration. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 655d411..b21d46e 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,20 @@ sub-directories. Each ## Configuration +There are two points of configuration when working with StrawBoss, the +[StrawBoss configuration file](#strawboss-configuration-file), and the +individual [project configurations](#project-configuration). + +The [StrawBoss configuration file](#strawboss-configuration-file) is used to +configure the StrawBoss instance itself and stores server-side information such +as the list of projects known to StrawBoss. If you are setting up StrawBoss on +a server you will need to work with this configuration file. + +The [project configurations](#project-configuration) are used to configure the +build process and options for each proejct and are stored with the projects +themselves. If you are working on a project that you wish to build with +StrawBoss you will be working with this configuration file. + ### StrawBoss configuration file StrawBoss expects to find `strawboss.config.json` in the working directory of