Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation of configuration file #146

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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