Skip to content

Commit

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

Signed-off-by: Norwid Behrnd <nbehrnd@yahoo.com>
  • Loading branch information
nbehrnd committed Mar 28, 2023
1 parent d6d24a8 commit e70a523
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,21 @@ 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 e70a523

Please sign in to comment.