mirror of https://github.com/captn3m0/muse-dl.git
Improve README
This commit is contained in:
parent
79b95e2a67
commit
9f0c9c5534
|
@ -3,4 +3,5 @@
|
||||||
/bin/
|
/bin/
|
||||||
/.shards/
|
/.shards/
|
||||||
*.dwarf
|
*.dwarf
|
||||||
*.pdf
|
*.pdf
|
||||||
|
*.o
|
22
README.md
22
README.md
|
@ -1,8 +1,20 @@
|
||||||
# muse-dl
|
# muse-dl
|
||||||
|
|
||||||
|
Download PDFs from Project MUSE and stitch them together into a single-file using [`pdftk`](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/).
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
TODO
|
```
|
||||||
|
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.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -12,9 +24,17 @@ Usage: muse-dl [--flags] URL
|
||||||
--tmp-dir PATH Temporary Directory to use
|
--tmp-dir PATH Temporary Directory to use
|
||||||
--output FILE Output Filename
|
--output FILE Output Filename
|
||||||
--no-bookmarks Don't add bookmarks in the PDF
|
--no-bookmarks Don't add bookmarks in the PDF
|
||||||
|
--clobber Overwrite the output file, if it already exists
|
||||||
-h, --help Show this help
|
-h, --help Show this help
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 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
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.
|
Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.
|
Loading…
Reference in New Issue