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] #142 Signed-off-by: Norwid Behrnd <[email protected]>
fortran-lang · Mar 28, 2023 · e70a523 · e70a523
1 parent d6d24a8
commit e70a523
Showing 1 changed file with 15 additions and 0 deletions.
diff --git 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