jdb/strawboss
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarification in the README around service vs. project configuration.

Browse Source
This commit is contained in:
Jonathan Bernard 2017-05-11 10:36:45 -05:00
parent 37682441ea
commit 45f490c677
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -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