forks
/
D-Scanner
mirror of https://github.com/dlang-community/D-Scanner.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated the readme to reflect the CWD-based config file search

This commit is contained in:
Ianis G. Vasilev 2016-05-20 02:33:49 +03:00
parent 322a191d5d
commit 265d102ad3
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -51,10 +51,10 @@ To avoid these cases, it's possible to pass the "--skipTests" option.
#### Configuration #### Configuration
By default all checks are enabled. Individual checks can be enabled or disabled By default all checks are enabled. Individual checks can be enabled or disabled
by using a configuration file. Running ```dscanner --defaultConfig``` will by using a configuration file. Such a file can be placed, for example, is the root directory of your project.
generate a default configuration file and print the file's location. The Running ```dscanner --defaultConfig``` will generate a default configuration file and print the file's location.
"--config" option will allow you to specify the path to a configuration file if You can also specify the path to a configuration file by using the "--config" option if
you do not want to use the one created by the "--defaultConfig" option. you want to override the default or the local settings.
For each check, three values are possible: For each check, three values are possible:
* `"disabled"`: the check is not performed. * `"disabled"`: the check is not performed.
@ -179,6 +179,7 @@ outline of the file's declarations to stdout.
By default Dscanner uses the configuration file given in `$HOME/.config/dscanner/dscanner.ini`. By default Dscanner uses the configuration file given in `$HOME/.config/dscanner/dscanner.ini`.
Run `--defaultConfig` to regenerate it. Run `--defaultConfig` to regenerate it.
The `--config` option allows one to use a custom configuration file. The `--config` option allows one to use a custom configuration file.
If a `dscanner.ini` file is locate in the working directory or any of it's parents, it overrides any other configuration files.
### AST Dump ### AST Dump
The "--ast" or "--xml" options will dump the complete abstract syntax tree of The "--ast" or "--xml" options will dump the complete abstract syntax tree of