From 576d5e8adfb95b0c476598ae88e0dfc7c07632f0 Mon Sep 17 00:00:00 2001 From: Norwid Behrnd Date: Fri, 31 Mar 2023 17:02:39 +0200 Subject: [PATCH] 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] https://github.com/pseewald/fprettify/issues/142 Signed-off-by: Norwid Behrnd --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 24ee740..d0031c0 100644 --- a/README.md +++ b/README.md @@ -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