From 667c5af25578c76c8018f71dcf323b88eca8af67 Mon Sep 17 00:00:00 2001 From: Joop Schilder Date: Thu, 25 Mar 2021 13:54:21 +0100 Subject: [PATCH] Add symlink explanation --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d53f372..2ab3da6 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,15 @@ as [poppler-utils](https://pypi.org/project/poppler-utils/). Installation of pop sudo apt update && sudo apt install poppler-utils ``` +The scripts are marked as executable so you can easily add them to your PATH. In my case, `~/.local/bin` is in my PATH, so I did the following: + +```sh +ln -s /path/to/repository/bin/pdf-finder.php ~/.local/bin/pdf-finder +ln -s /path/to/repository/bin/pdf-show-info.php ~/.local/bin/pdf-show-info +``` + +Now you can just invoke them with `pdf-finder` and `pdf-show-info` respectively. + ## Finding documents: `bin/pdf-finder.php` The first executable, `pdf-finder.php`, is used to actually find PDFs based on search terms. The first argument should