summaryrefslogtreecommitdiffhomepage
path: root/README.markdown
diff options
context:
space:
mode:
authorJasper Van der Jeugt <m@jaspervdj.be>2012-06-06 11:47:29 +0200
committerJasper Van der Jeugt <m@jaspervdj.be>2012-06-06 11:47:29 +0200
commite662d09c53fabb7b55cfdbb098eb276f139c0d5b (patch)
treea7e1f89a914c8722a4cc516d06768d0a1fd856b6 /README.markdown
parent41a5af08fffad69010d7163769207d8a1857cf97 (diff)
downloadstylish-haskell-e662d09c53fabb7b55cfdbb098eb276f139c0d5b.tar.gz
More notes on configuration
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown
index 9831935..9520cd1 100644
--- a/README.markdown
+++ b/README.markdown
@@ -65,7 +65,19 @@ into:
Configuration
-------------
-The tool is customizable to some extent.
+The tool is customizable to some extent. It tries to find a config file in the
+following order:
+
+1. A file passed to the tool using the `-c/--config` argument
+2. `.stylish-haskell.yaml` in the current directory (useful for per-project
+ settings)
+3. `.stylish-haskell.yaml` in your home directory (useful for user-wide
+ settings)
+4. The default settings.
+
+Use `stylish-haskell --defaults > .stylish-haskell.yaml` to dump a
+well-documented default configuration to a file, this way you can get started
+quickly.
VIM integration
---------------