Skip to content

Commit 576d5e8

Browse files
committed
add description of an optional config file
There was the request to display the use a configuration file.[1] The documentation now includes a minimal example and indicates an example in a larger project. [1] #142 Signed-off-by: Norwid Behrnd <[email protected]>
1 parent 6b239b6 commit 576d5e8

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,18 @@ 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 pattern like
109+
110+
```sh
111+
# Explicitly define / overwrite the program's defaults e.g.
112+
indent=2
113+
whitespace=0
114+
```
115+
116+
The rules are activated by the optional parameter `-c` and subsequent indication of the config file in question. For one example of application, see the setup of [ABIN](https://github.com/PHOTOX/ABIN/blob/master/.fprettify.rc).
117+
106118
## Editor integration
107119

108120
For editor integration, use

0 commit comments

Comments
 (0)