Clarification in the README around service vs. project configuration.
This commit is contained in:
parent
37682441ea
commit
45f490c677
14
README.md
14
README.md
@ -33,6 +33,20 @@ sub-directories. Each
|
|||||||
|
|
||||||
## Configuration
|
## 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 configuration file
|
||||||
|
|
||||||
StrawBoss expects to find `strawboss.config.json` in the working directory of
|
StrawBoss expects to find `strawboss.config.json` in the working directory of
|
||||||
|
Loading…
x
Reference in New Issue
Block a user