joopschilder
/
pdf-finder
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add symlink explanation

This commit is contained in:
Joop Schilder 2021-03-25 13:54:21 +01:00
parent cc2696668c
commit 667c5af255
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -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