Skip to content

Commit a0a8f5c

Browse files
committed
add description of an optional config file
There has been the request for an example how to set up and use a configuration file.[1] The documentation now includes both a minimal example, as well as points to an example in a larger project. [1] #142 Signed-off-by: Norwid Behrnd <[email protected]>
1 parent 6db5d1c commit a0a8f5c

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,21 @@ For more options, read
113113
fprettify -h
114114
```
115115

116+
## Configuration file
117+
118+
Adjusted parameters of `fprettify` can be stored in a configuration file in a
119+
pattern like
120+
121+
```sh
122+
# Explicitly define / overwrite the program's defaults e.g.
123+
indent=2
124+
whitespace=0
125+
```
126+
127+
The rules are activated by the optional parameter `-c` and subsequent indication
128+
of the config file in question. For one example of application, see the setup of
129+
[ABIN](https://github.com/PHOTOX/ABIN/blob/master/.fprettify.rc).
130+
116131
## Editor integration
117132

118133
For editor integration, use

0 commit comments

Comments
 (0)