Skip to content

Commit

Permalink
add description of an optional config file
Browse files Browse the repository at this point in the history
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] https://github.com/pseewald/fprettify/issues/142

Signed-off-by: Norwid Behrnd <nbehrnd@yahoo.com>
  • Loading branch information
nbehrnd committed Mar 31, 2023
1 parent 6b239b6 commit 576d5e8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,18 @@ For more options, read
fprettify -h
```

## Configuration file

Adjusted parameters of `fprettify` can be stored in a configuration file in a pattern like

```sh
# Explicitly define / overwrite the program's defaults e.g.
indent=2
whitespace=0
```

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).

## Editor integration

For editor integration, use
Expand Down

0 comments on commit 576d5e8

Please sign in to comment.