From a5269a3b345ff1abc72e171951700005ccfd35f2 Mon Sep 17 00:00:00 2001
From: stuebinm
Date: Sun, 14 Nov 2021 18:44:28 +0100
Subject: add readme

---
 src/Main.hs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/Main.hs b/src/Main.hs
index 5b8b66f..be28f07 100644
--- a/src/Main.hs
+++ b/src/Main.hs
@@ -37,8 +37,11 @@ data Options = Options
   , pretty       :: Bool
   -- ^ pretty-print the json to make it human-readable
   , out          :: Maybe String
-  , config       :: Maybe (LintConfig Maybe)
+  -- ^ path to write the (possibly adjusted) maps to after linting
   , configFile   :: Maybe FilePath
+  -- ^ path to a config file. Currently required.
+  , config       :: Maybe (LintConfig Maybe)
+  -- ^ a "patch" for the configuration file
   } deriving (Show, Generic, HasArguments)
 
 
-- 
cgit v1.2.3