From 0b4b3b6575347fa6f9e1e95ae6a1e10e741f33fa Mon Sep 17 00:00:00 2001 From: "Harry R. Schwartz" Date: Wed, 7 Jun 2023 15:00:11 -0400 Subject: [PATCH] Warn: `docsim` doesn't understand `.ignore` files --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e13ae2e..a5ff4c3 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,10 @@ algorithm, you'll almost certainly want to use the `--no-stoplist` and Optionally, you can use the `--stoplist` flag to provide a custom stoplist. A custom stoplist is just a text file of words to ignore, separated by whitespace. +**WARNING:** `docsim` doesn't respect `.ignore` files yet, so it'll try to +search through `.git` directories, `node_modules`, and so on. That should be +fixed in the near future. + ## Installation The easiest thing is probably to grab a [compiled binary][] appropriate to your @@ -93,12 +97,14 @@ $ go install github.com/hrs/docsim/docsim@latest ``` Note that using `go install` doesn't include the [`man` page][], which you can -optionally install manually by copying into e.g. `/usr/local/share/man/man1`. +optionally install manually by copying it into e.g. `/usr/local/share/man/man1`. [`man` page]: ./man/docsim.1 ## Running tests +Just use the supplied `make` task: + ``` console $ make test ```