Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
2mol authored Jun 14, 2018
1 parent d1763f1 commit 0885f18
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,18 @@

PaperBoy is a small .pdf management utility.

It is borne out of the frustration that most documents you download have pretty useless file names.
I was frustrated that most PDFs have pretty useless file names.

* My download folder is dump of those documents like `PFP_JFP06.pdf` or `1803.05316.pdf`, mixed in with `omg%20cutesnowleopard.png`, `DXOpsCwX0AA3JXi.jpeg`, `David\ Lynch Teaches\ Typing.zip`, and about a hundred other files like that.
* I have zero desire to manually 1) crawl through that mess of a folder, 2) open the .pdfs to find out what's in them, 3) decide which ones I want to keep, 4) think of a filename, 5) rename it, and 6) move it to some precious library folder.

Well, `paperboy` helps to rename those files without too much fuss. It will rename/move files to a specified specified folder, and it even gives some suggestions for the filename by looking at the file metadata and the content.
`paperboy` helps to rename those files without too much fuss. It will rename/move files to a specified specified folder, and it even gives some suggestions for the filename by looking at the file metadata and the content.

Paperboy aims to keep its file management dumb (no keeping files in a database or hidden library folder), so you can uninstall it at any time and your files will remain perfectly accessible.

# Config

PaperBoy creates a `.pboy.toml` in your home directory. Use this to change your library and incoming folders, as well as to specify whether you want to move the imported files or just copy them.

# Limitations

Current state is super alpha. There is not a lot of exception handling for missing folders or missing utility programs.

Two command line tools are required for the suggestions: `pdftotext` and `pdfinfo`. Both come with the poppler package as far as I'm aware.

0 comments on commit 0885f18

Please sign in to comment.