From e70a523caade1acb4f62c028daee814d5a0ad33b Mon Sep 17 00:00:00 2001 From: Norwid Behrnd Date: Tue, 28 Mar 2023 21:37:02 +0200 Subject: [PATCH] add description of an optional config file 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 --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 767024c..a574d01 100644 --- a/README.md +++ b/README.md @@ -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