summaryrefslogtreecommitdiffhomepage
path: root/README.markdown
diff options
context:
space:
mode:
authorMikhail Glushenkov <the.dead.shall.rise@gmail.com>2012-11-05 14:48:32 +0100
committerMikhail Glushenkov <the.dead.shall.rise@gmail.com>2012-11-05 14:53:17 +0100
commit559a8062bc98315a00e492899d2167955bcf3ca9 (patch)
tree36a7d1084f5744bc17b21e6582edb58991a078e6 /README.markdown
parent28ba0499f8f5be9d9308df2408707efa6d6b59a4 (diff)
downloadstylish-haskell-559a8062bc98315a00e492899d2167955bcf3ca9.tar.gz
Search for the config file in the project root.
Project root is defined as the nearest ancestor directory that contains a .stylish-haskell.yaml file (the same logic that Git uses for finding the .git directory). Project root is searched after the current directory, but before the home directory.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.markdown b/README.markdown
index 9fc0b49..d05c0c6 100644
--- a/README.markdown
+++ b/README.markdown
@@ -78,11 +78,13 @@ 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
+2. `.stylish-haskell.yaml` in the current directory (useful for per-directory
settings)
-3. `.stylish-haskell.yaml` in your home directory (useful for user-wide
+3. `.stylish-haskell.yaml` in the nearest ancestor directory (useful for
+ per-project settings)
+4. `.stylish-haskell.yaml` in your home directory (useful for user-wide
settings)
-4. The default settings.
+5. 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