From a2e69c93349e461b4ac5801c1e6b5ad226f71c20 Mon Sep 17 00:00:00 2001 From: Steven Berlanga Date: Thu, 6 Aug 2015 12:43:32 -0400 Subject: [PATCH] added caveats section to readme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11ca522..6c00af4 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,16 @@ snag From a project with a `.snag.yml` file and develop away! -## Troubleshooting +## Caveats + +* Endless build loops + +Snag will run your configured scripts if **ANY** file modifed in your current directory. +If you scripts generate any files, you should add them to the `ignore` section in your +`.snag.yml` to avoid an endless build loop. + + +## Known Issues * `open /dev/null: too many open files`