Skip to content

Commit e70a523

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 d6d24a8 commit e70a523

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
@@ -103,6 +103,21 @@ For more options, read
103103
fprettify -h
104104
```
105105

106+
## Configuration file
107+
108+
Adjusted parameters of `fprettify` can be stored in a configuration file in a
109+
pattern like
110+
111+
```sh
112+
# Explicitly define / overwrite the program's defaults e.g.
113+
indent=2
114+
whitespace=0
115+
```
116+
117+
The rules are activated by the optional parameter `-c` and subsequent indication
118+
of the config file in question. For one example of application, see the setup of
119+
[ABIN](https://github.com/PHOTOX/ABIN/blob/master/.fprettify.rc).
120+
106121
## Editor integration
107122

108123
For editor integration, use

0 commit comments

Comments
 (0)