diff --git a/CHANGELOG.md b/CHANGELOG.md index ffc6e81..d6049d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,11 @@ ambiguous situations. ## Unreleased +If your config file doesn't do weird things with transforms, it should continue +to work. If your `-re->` arrows behave weirdly, try replacing them with +`-exact-re->` arrows. If you're on Windows, you might need to switch from `\` +path separators to `/` in your regex rules. + ### Added - `skip` option for crawlers - Rules with `>>` instead of `>` as arrow head diff --git a/CONFIG.md b/CONFIG.md index f2710e1..19afbd2 100644 --- a/CONFIG.md +++ b/CONFIG.md @@ -342,7 +342,8 @@ Example: `\..+ -name-re-> !` ### The `-exact-re->` arrow -The `-exact-re>` arrow is like a combination of the `-exact->` and `-re->` arrows. +The `-exact-re>` arrow is like a combination of the `-exact->` and `-re->` +arrows. Example: `f(oo+)/be?ar -exactre-> B{g1.upper()}H/fear` - Doesn't match `a/foo/bar`, `foo/abc/bar`, `afoo/bar` or `foo/bars` @@ -375,8 +376,7 @@ tutorials --> ! The second rule is required for many crawlers since they use the rules to decide which directories to crawl. If it was missing when the crawler looks at `tutorials/`, the third rule would match. This means the crawler would not crawl -the `tutorials/` directory and thus not discover that `tutorials/tut02/` -exists. +the `tutorials/` directory and thus not discover that `tutorials/tut02/` exists. Since the second rule is only relevant for crawling, the `TARGET` is left out. diff --git a/README.md b/README.md index 681bdf7..836147f 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,9 @@ The use of [venv](https://docs.python.org/3/library/venv.html) is recommended. ## Basic usage -PFERD can be run directly from the command line with no config file. -Run `pferd -h` to get an overview of available commands and options. -Run `pferd -h` to see which options a command has. +PFERD can be run directly from the command line with no config file. Run `pferd +-h` to get an overview of available commands and options. Run `pferd +-h` to see which options a command has. For example, you can download your personal desktop from the KIT ILIAS like this: