Merge pull request #226 from stepchowfun/paths

Clarify the meaning of the paths for file and directory references
stepchowfun · Apr 12, 2024 · b5024c4 · b5024c4
2 parents 4aaa08f + 2562d98
commit b5024c4
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,8 @@ A directory reference guarantees that the given directory exists. For example:
 # This script will format the files in [dir:src].
 ```
 
+File and directory paths are relative to the working directory, which is typically the root of the project or repository.
+
 ## Tag names
 
 The name of a tag may consist of any UTF-8 text except the right square bracket `]`. Internal whitespace (as in `[tag:foo bar]`) is allowed, and surrounding whitespace (as in `[tag: baz ]`) is ignored. Tag names are case-sensitive, so `[tag:foo]` and `[tag:Foo]` are different tags.