Skip to content

Commit

Permalink
Add TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre B committed Aug 1, 2018
1 parent e05a5e1 commit dd877ce
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

Quickly find and open a pdf among a collection of thousands of unsorted pdfs through fzf (fuzzy finder)

![illustration of the p command](https://user-images.githubusercontent.com/1019692/34446795-12229072-ecac-11e7-856a-ec0df0de60ae.gif)
- [Installation](#installation)
- [Usage](#usage)
- [See it in action](#see-it-in-action)
- [Is the historical bash code still available?](#is-the-historical-bash-code-still-available)

# Installation

Expand All @@ -15,7 +18,7 @@ Quickly find and open a pdf among a collection of thousands of unsorted pdfs thr
2. __Install binary__. Do either one of the two steps below:
- __Compile from source with ``go`` and ``go get``.__
With a working ``golang`` installationm, do
``go get github.com/bellecp/fast-p```
```go get github.com/bellecp/fast-p```
It will fetch the code and its dependencies,
compile and create an executable ``fast-p`` in the ``/bin`` folder of your go
installation, typically ``~/go/bin``. Make sure the command ``fast-p`` can be
Expand Down Expand Up @@ -44,9 +47,14 @@ You may replace ``ag -U -g ".pdf$`` with another command that returns a list of

# Usage

Use the command ``p`` to browse among your pdfs.
Use the command ``p`` to browse among the PDF files in the current directory and its subdirectories.

The first run of the command will take some time to cache the text extracted from each pdf. Further runs of the command will be much faster since the text extraction will only apply to new pdfs.

# See it in action

![illustration of the p command](https://user-images.githubusercontent.com/1019692/34446795-12229072-ecac-11e7-856a-ec0df0de60ae.gif)


# Is the historical bash code still available?

Expand Down

0 comments on commit dd877ce

Please sign in to comment.