diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x[-rw-r--r--] | docs/quickstart.md | 15 |
1 files changed, 4 insertions, 11 deletions
diff --git a/docs/quickstart.md b/docs/quickstart.md index 5d71c77a..e6fb9b3d 100644..100755 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -8,28 +8,21 @@ Follow the [installation instructions] to install. ## Configure the `./conf/10_custom.conf` file -The supplied `10_custom.conf` file must be modified, as it contains -configuration items for which there are no reasonable default values. +The supplied `10_custom.conf` file must be modified, as it contains configuration items for which there are no reasonable default values. -The configuration items that can be added is not limited to the initial -contents. Any configuration item mentioned in any .conf file in `./conf` -directory can be added and that item will be overridden by the custom +The configuration items that can be added is not limited to the initial contents. Any configuration item mentioned in any .conf file in `./conf` directory can be added and that item will be overridden by the custom configuration value. ## Using a custom settings file -Alternatively a custom settings file can be passed to `vsperf` via the -`--conf-file` argument. +Alternatively a custom settings file can be passed to `vsperf` via the `--conf-file` argument. ```bash ./vsperf --conf-file <path_to_settings_py> ... ``` -Note that configuration passed in via the environment (`--load-env`) or via -another command line argument will override both the default and your custom -configuration files. This "priority hierarchy" can be described like so (1 = -max priority): +Note that configuration passed in via the environment (`--load-env`) or via another command line argument will override both the default and your custom configuration files. This "priority hierarchy" can be described like so (1 = max priority): 1. Command line arguments 2. Environment variables |