muse-dl/README.md

40 lines
1.1 KiB
Markdown
Raw Normal View History

2020-03-28 19:29:47 +00:00
# muse-dl
2020-03-29 18:52:59 +00:00
Download PDFs from Project MUSE and stitch them together into a single-file using [`pdftk`](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/).
2020-03-28 19:29:47 +00:00
# Installation
2020-03-29 18:52:59 +00:00
```
git clone https://github.com/captn3m0/muse-dl.git
cd muse-dl
shards install
shards build
./bin/muse-dl --help
```
## Requirements
Please ensure you have `pdftk` installed, and run the `muse-dl` binary. To build the binary, please run the steps in Installation.
2020-03-28 19:29:47 +00:00
## Usage
```
2020-03-29 14:04:51 +00:00
Usage: muse-dl [--flags] URL
--no-cleanup Don't cleanup temporary files
--tmp-dir PATH Temporary Directory to use
--output FILE Output Filename
--no-bookmarks Don't add bookmarks in the PDF
2020-03-29 18:52:59 +00:00
--clobber Overwrite the output file, if it already exists
2020-03-29 14:04:51 +00:00
-h, --help Show this help
2020-03-28 19:29:47 +00:00
```
2020-03-29 18:52:59 +00:00
## Sample Run
```
muse-dl https://muse.jhu.edu/book/875
Saved final output to Accommodating Revolutions- Virginia's Northern Neck in an Era of Transformations, 1760-1810.pdf
```
2020-03-28 19:29:47 +00:00
## License
Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.