From 21e334a1c1e8d70974f6e0cca2fe6a05c25abc48 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Mon, 3 Feb 2020 22:09:55 +0000 Subject: Update readme with HTML source support --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dc05a23..1429483 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ transferring an academic paper to your [reMarkable](https://remarkable.com/): $ p2r https://arxiv.org/abs/1811.11242 ``` +There is also support for transferring an article from a website: + +``` +p2r --html https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines +``` + The script can be run through the ``p2r`` command line program or via Docker (see below). @@ -26,11 +32,12 @@ reMarkable from any of the following sources: * [SpringerLink](https://link.springer.com/) * A generic URL to a PDF file * A local PDF file +* Any article on a website (using ``--html``) The program aims to be flexible to the exact source URL, so for many of the -sources you can either provide a URL to the abstract page or to the PDF file. -If you have an source that you would like to see added to the list, let me -know! +academic sources you can either provide a URL to the abstract page or to the +PDF file. If you have an source that you would like to see added to the list, +let me know! ``paper2remarkable`` takes the source URL and: -- cgit v1.2.3 From 941e893497ae69f9e4db653c83afff8df3c9c436 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Mon, 3 Feb 2020 22:20:32 +0000 Subject: Bump version and update changelog --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1429483..b12dbf6 100644 --- a/README.md +++ b/README.md @@ -61,18 +61,19 @@ Optionally, you can: Here's the full help of the script: ```text -usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-v] +usage: p2r [-h] [-t] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-v] [-V] [--filename FILENAME] [--gs GS] [--pdfcrop PDFCROP] [--pdftk PDFTK] [--rmapi RMAPI] input -Paper2reMarkable version 0.4.0 +Paper2reMarkable version 0.5.0 positional arguments: input URL to a paper or the path of a local PDF file optional arguments: -h, --help show this help message and exit + -t, --html URL is to a HTML article instead of a PDF -b, --blank Add a blank page after every page of the PDF -c, --center Center the PDF on the page, instead of left align -d, --debug debug mode, doesn't upload to reMarkable @@ -82,6 +83,7 @@ optional arguments: directory on reMarkable to put the file (created if missing, default: /) -v, --verbose be verbose + -V, --version Show version and exit --filename FILENAME Filename to use for the file on reMarkable --gs GS path to gs executable (default: gs) --pdfcrop PDFCROP path to pdfcrop executable (default: pdfcrop) -- cgit v1.2.3 From 5383d413837f153fb5f4d519f9d624ad0a0f5cef Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Mon, 3 Feb 2020 22:21:44 +0000 Subject: Minor readme typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index b12dbf6..027cf78 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ $ p2r https://arxiv.org/abs/1811.11242 There is also support for transferring an article from a website: ``` -p2r --html https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines +$ p2r --html https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines ``` The script can be run through the ``p2r`` command line program or via Docker -- cgit v1.2.3 From 219b0d756faefb737cd6c65c27af32fe7661535e Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Tue, 4 Feb 2020 11:10:07 +0000 Subject: Bump version and update changelog --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 027cf78..e639864 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ $ p2r https://arxiv.org/abs/1811.11242 There is also support for transferring an article from a website: ``` -$ p2r --html https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines +$ p2r https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines ``` The script can be run through the ``p2r`` command line program or via Docker @@ -32,11 +32,11 @@ reMarkable from any of the following sources: * [SpringerLink](https://link.springer.com/) * A generic URL to a PDF file * A local PDF file -* Any article on a website (using ``--html``) +* Any article on a website The program aims to be flexible to the exact source URL, so for many of the academic sources you can either provide a URL to the abstract page or to the -PDF file. If you have an source that you would like to see added to the list, +PDF file. If you have an source that you would like to see added to the list, let me know! ``paper2remarkable`` takes the source URL and: @@ -66,14 +66,13 @@ usage: p2r [-h] [-t] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-v] [-V] [--rmapi RMAPI] input -Paper2reMarkable version 0.5.0 +Paper2reMarkable version 0.5.1 positional arguments: input URL to a paper or the path of a local PDF file optional arguments: -h, --help show this help message and exit - -t, --html URL is to a HTML article instead of a PDF -b, --blank Add a blank page after every page of the PDF -c, --center Center the PDF on the page, instead of left align -d, --debug debug mode, doesn't upload to reMarkable -- cgit v1.2.3 From b895efee7c8a8ddbd13e19a9bc777ed4450c5865 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Wed, 19 Feb 2020 12:54:53 +0000 Subject: Readme update --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index e639864..7b5c9ad 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ reMarkable from any of the following sources: * [arXiv](https://arxiv.org/) * [ACM Digital Library](https://dl.acm.org/dl.cfm) * [CiteSeerX](http://citeseerx.ist.psu.edu/index) +* [NBER](https://www.nber.org) * [NeurIPS](https://papers.nips.cc/) * [OpenReview](https://openreview.net/) * [PMLR](http://proceedings.mlr.press/) @@ -131,7 +132,7 @@ This installs the ``p2r`` command line program. ## Docker -You can also use our Dockerfile to avoid installing dependencies on your +You can also use the Dockerfile to avoid installing dependencies on your machine. You will need `git` and `docker` installed. First clone this repository with `git clone` and `cd` inside of it, then build -- cgit v1.2.3 From de7fa6bf3b7c25eb2a2e07fce769b515bca92e7d Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 21 Feb 2020 16:23:01 +0000 Subject: Add provider for JMLR --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 7b5c9ad..446682e 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ reMarkable from any of the following sources: * [arXiv](https://arxiv.org/) * [ACM Digital Library](https://dl.acm.org/dl.cfm) * [CiteSeerX](http://citeseerx.ist.psu.edu/index) +* [JMLR](http://jmlr.org) * [NBER](https://www.nber.org) * [NeurIPS](https://papers.nips.cc/) * [OpenReview](https://openreview.net/) -- cgit v1.2.3 From 4501d3fb80199a4c0220372795b571e3e018ffca Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 22 Feb 2020 13:26:25 +0000 Subject: Remove pdfcrop dependency --- README.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7b5c9ad..4f3a93e 100644 --- a/README.md +++ b/README.md @@ -115,8 +115,6 @@ $ p2r -v https://arxiv.org/abs/1811.11242 The script requires the following external programs to be available: - [pdftk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/) -- [pdfcrop](https://ctan.org/pkg/pdfcrop?lang=en): usually included with a - LaTeX installation. - [GhostScript](https://www.ghostscript.com/) - [rMAPI](https://github.com/juruen/rmapi) -- cgit v1.2.3 From 6f12b10d064d7a938197ce0c4942c4f7136840e2 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 22 Feb 2020 13:26:54 +0000 Subject: Add pdftoppm to readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 4f3a93e..dd11653 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,9 @@ The script requires the following external programs to be available: - [pdftk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/) - [GhostScript](https://www.ghostscript.com/) - [rMAPI](https://github.com/juruen/rmapi) +- [pdftoppm](https://linux.die.net/man/1/pdftoppm) Optional, but recommended + for speed. Usually part of a [Poppler](https://poppler.freedesktop.org/) + installation. If these scripts are not available on the ``PATH`` variable, you can supply them with the relevant options to the script. Then, you can install -- cgit v1.2.3 From fe54ffe6eb2aece346f6727aedd8edecf6392d77 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 22 Feb 2020 14:26:41 +0000 Subject: update readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dfaae7d..aa884eb 100644 --- a/README.md +++ b/README.md @@ -63,12 +63,12 @@ Optionally, you can: Here's the full help of the script: ```text -usage: p2r [-h] [-t] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-v] [-V] - [--filename FILENAME] [--gs GS] [--pdfcrop PDFCROP] [--pdftk PDFTK] - [--rmapi RMAPI] +usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-v] [-V] + [--filename FILENAME] [--gs GS] [--pdftoppm PDFTOPPM] + [--pdftk PDFTK] [--rmapi RMAPI] input -Paper2reMarkable version 0.5.1 +Paper2reMarkable version 0.5.3 positional arguments: input URL to a paper or the path of a local PDF file @@ -87,7 +87,7 @@ optional arguments: -V, --version Show version and exit --filename FILENAME Filename to use for the file on reMarkable --gs GS path to gs executable (default: gs) - --pdfcrop PDFCROP path to pdfcrop executable (default: pdfcrop) + --pdftoppm PDFTOPPM path to pdftoppm executable (default: pdftoppm) --pdftk PDFTK path to pdftk executable (default: pdftk) --rmapi RMAPI path to rmapi executable (default: rmapi) ``` -- cgit v1.2.3 From 1bdf321d81a733a4ae9547f655501ddf92de0343 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sun, 23 Feb 2020 16:10:47 +0000 Subject: Bump version and update changelog and readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index aa884eb..18753af 100644 --- a/README.md +++ b/README.md @@ -63,12 +63,12 @@ Optionally, you can: Here's the full help of the script: ```text -usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-v] [-V] +usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--filename FILENAME] [--gs GS] [--pdftoppm PDFTOPPM] [--pdftk PDFTK] [--rmapi RMAPI] input -Paper2reMarkable version 0.5.3 +Paper2reMarkable version 0.5.4 positional arguments: input URL to a paper or the path of a local PDF file @@ -83,6 +83,8 @@ optional arguments: -p REMARKABLE_DIR, --remarkable-path REMARKABLE_DIR directory on reMarkable to put the file (created if missing, default: /) + -r, --right Right align so the menu doesn't cover it + -k, --no-crop Don't crop the pdf file -v, --verbose be verbose -V, --version Show version and exit --filename FILENAME Filename to use for the file on reMarkable -- cgit v1.2.3 From 2dd984eb80bff1a6828a197e9d225c4676e1d432 Mon Sep 17 00:00:00 2001 From: Simon Eskildsen Date: Sun, 23 Feb 2020 14:08:52 -0500 Subject: alfred: add alfred workflow --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 18753af..c2b3447 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,9 @@ There is also support for transferring an article from a website: $ p2r https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines ``` -The script can be run through the ``p2r`` command line program or via Docker -(see below). +The script can be run through the ``p2r`` command line program or via Docker +(see below). If you're using MacOS, you might be interested in the [Alfred +workflow](#alfred). ``paper2remarkable`` makes it as easy as possible to get a PDF on your reMarkable from any of the following sources: @@ -134,6 +135,21 @@ pip install paper2remarkable This installs the ``p2r`` command line program. +## Alfred + +Install the [Alfred workflow][workflow], which is [a launcher for +MacOS](https://www.alfredapp.com/). + +Once installed, you can use `rm` command and `rmb` (for the `--blank` pages to +insert blank pages between pages for notes) with a URL passed. The global +shortcut `Alt-P` will send the current selection to `p2r`. Note that by default +`--right` is passed and `p2r` is executed in your `bash` environment. You can +edit the Workflow in Alfred if this doesn't work for your setup. + +![Alfred Screenshot](https://raw.githubusercontent.com/GjjvdBurg/paper2remarkable/master/.github/alfred.png) + +[workflow]: https://github.com/GjjvdBurg/paper2remarkable/blob/master/Remarkable.alfredworkflow?raw=true + ## Docker You can also use the Dockerfile to avoid installing dependencies on your -- cgit v1.2.3 From 74c0240b7022e199124acd8941d9fa3a1bea228f Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Tue, 25 Feb 2020 11:41:04 +0000 Subject: Minor readme updates --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c2b3447..fcb1743 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,8 @@ Optionally, you can: - Download a paper but not upload to the reMarkable using the ``-n`` switch. - Insert a blank page after each page using the ``-b`` switch (useful for note taking!) -- Center the pdf on the reMarkable (default is left-aligned) +- Center (``-c``) or right-align (``-r``) the pdf on the reMarkable (default + is left-aligned), or disable cropping altogether (``-k``). - Provide an explicit filename using the ``--filename`` parameter - Specify the location on the reMarkable to place the file (default ``/``) @@ -118,12 +119,18 @@ $ p2r -v https://arxiv.org/abs/1811.11242 The script requires the following external programs to be available: -- [pdftk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/) +- [pdftk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/), or + ``pdftk-java``, whichever your package manager provides. - [GhostScript](https://www.ghostscript.com/) -- [rMAPI](https://github.com/juruen/rmapi) - [pdftoppm](https://linux.die.net/man/1/pdftoppm) Optional, but recommended for speed. Usually part of a [Poppler](https://poppler.freedesktop.org/) installation. +- [rMAPI](https://github.com/juruen/rmapi) + +On Arch, use ``pacman -S pdftk ghostscript poppler``, on Ubuntu try ``apt-get +install pdftk ghostscript poppler-utils``, and on Mac: ``brew install +pdftk-java poppler``. For [rMAPI](https://github.com/juruen/rmapi), use ``go +get -u github.com/juruen/rmapi``. If these scripts are not available on the ``PATH`` variable, you can supply them with the relevant options to the script. Then, you can install -- cgit v1.2.3 From c4cd0543d6d88975f006869b379ff2cc23d22fa4 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Tue, 3 Mar 2020 11:02:22 +0000 Subject: Add ghostscript to install instructions homebrew --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fcb1743..3d59768 100644 --- a/README.md +++ b/README.md @@ -129,8 +129,9 @@ The script requires the following external programs to be available: On Arch, use ``pacman -S pdftk ghostscript poppler``, on Ubuntu try ``apt-get install pdftk ghostscript poppler-utils``, and on Mac: ``brew install -pdftk-java poppler``. For [rMAPI](https://github.com/juruen/rmapi), use ``go -get -u github.com/juruen/rmapi``. +pdftk-java ghostscript poppler``. For +[rMAPI](https://github.com/juruen/rmapi), use ``go get -u +github.com/juruen/rmapi``. If these scripts are not available on the ``PATH`` variable, you can supply them with the relevant options to the script. Then, you can install -- cgit v1.2.3 From 1117b973fe14b018376359176a27a906e76c6391 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 20 Mar 2020 20:09:34 +0000 Subject: add instructions for local file with docker --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3d59768..2bc4e35 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,9 @@ docker run --rm -v "${HOME}/.rmapi:/home/user/.rmapi:rw" p2r --help # equivalent to above usage docker run --rm -v "${HOME}/.rmapi:/home/user/.rmapi:rw" p2r -v https://arxiv.org/abs/1811.11242 + +# to transfer a local file in the current directory +docker run --rm -v "${HOME}/.rmapi:/home/user/.rmapi:rw" -v "$(pwd):/home/user:r" p2r -v localfile.pdf ``` You can also create an [alias](http://tldp.org/LDP/abs/html/aliases.html) in -- cgit v1.2.3 From c4ff7ee4533e13c0d81a138955d1f7dfe724c2ff Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 4 Apr 2020 23:20:50 +0100 Subject: Bump version and update changelog and readme --- README.md | 77 ++++++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 44 insertions(+), 33 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2bc4e35..5de3ba9 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@ $ p2r https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines The script can be run through the ``p2r`` command line program or via Docker (see below). If you're using MacOS, you might be interested in the [Alfred -workflow](#alfred). +workflow](#alfred). On Linux, a background terminal such as +[Guake](http://guake-project.org/) can be very handy. ``paper2remarkable`` makes it as easy as possible to get a PDF on your reMarkable from any of the following sources: @@ -44,7 +45,7 @@ let me know! ``paper2remarkable`` takes the source URL and: -1. Downloads the pdf if necessary +1. Downloads the pdf 2. Removes the arXiv timestamp (for arXiv sources) 3. Crops the pdf to remove unnecessary borders 4. Shrinks the pdf file to reduce the filesize @@ -67,10 +68,10 @@ Here's the full help of the script: ```text usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--filename FILENAME] [--gs GS] [--pdftoppm PDFTOPPM] - [--pdftk PDFTK] [--rmapi RMAPI] + [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.5.4 +Paper2reMarkable version 0.6.0 positional arguments: input URL to a paper or the path of a local PDF file @@ -93,6 +94,7 @@ optional arguments: --gs GS path to gs executable (default: gs) --pdftoppm PDFTOPPM path to pdftoppm executable (default: pdftoppm) --pdftk PDFTK path to pdftk executable (default: pdftk) + --qpdf QPDF path to qpdf executable (default: qpdf) --rmapi RMAPI path to rmapi executable (default: rmapi) ``` @@ -119,40 +121,48 @@ $ p2r -v https://arxiv.org/abs/1811.11242 The script requires the following external programs to be available: -- [pdftk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/), or - ``pdftk-java``, whichever your package manager provides. +- [pdftk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/), + [qpdf](http://qpdf.sourceforge.net/), or + [pdftk-java](https://gitlab.com/pdftk-java/pdftk), whichever your package + manager provides. - [GhostScript](https://www.ghostscript.com/) -- [pdftoppm](https://linux.die.net/man/1/pdftoppm) Optional, but recommended - for speed. Usually part of a [Poppler](https://poppler.freedesktop.org/) - installation. - [rMAPI](https://github.com/juruen/rmapi) +- Optional: [pdftoppm](https://linux.die.net/man/1/pdftoppm) (recommended for + speed). Usually part of a [Poppler](https://poppler.freedesktop.org/) + installation. -On Arch, use ``pacman -S pdftk ghostscript poppler``, on Ubuntu try ``apt-get -install pdftk ghostscript poppler-utils``, and on Mac: ``brew install -pdftk-java ghostscript poppler``. For -[rMAPI](https://github.com/juruen/rmapi), use ``go get -u -github.com/juruen/rmapi``. - -If these scripts are not available on the ``PATH`` variable, you can supply -them with the relevant options to the script. Then, you can install -``paper2remarkable`` from PyPI: - -``` -pip install paper2remarkable -``` - -This installs the ``p2r`` command line program. +Specifically: + +1. First install [rMAPI](https://github.com/juruen/rmapi), using + ``` + $ go get -u github.com/juruen/rmapi + ``` +2. Then install system dependencies: + - **Arch Linux:** ``pacman -S pdftk ghostscript poppler`` + - **Ubuntu:** ``apt-get install pdftk ghostscript poppler-utils``. Replace + ``pdftk`` with ``qpdf`` if your distribution doesn't package ``pdftk``. + - **MacOs:** ``brew install pdftk-java ghostscript poppler`` (using [HomeBrew](https://brew.sh/)). +3. Finally, install ``paper2remarkable``: + ``` + $ pip install paper2remarkable + ``` + this installs the ``p2r`` command line program. + +If any of the dependencies are not available on the ``PATH`` variable, you can +supply them with the relevant options to the script (for instance ``p2r +--rmapi /path/to/rmapi``). If you run into trouble with the installation, +please let me know! ## Alfred -Install the [Alfred workflow][workflow], which is [a launcher for -MacOS](https://www.alfredapp.com/). +On MacOS, you can optionally install [this Alfred workflow][workflow]. Alfred +is [a launcher for MacOS](https://www.alfredapp.com/). -Once installed, you can use `rm` command and `rmb` (for the `--blank` pages to -insert blank pages between pages for notes) with a URL passed. The global -shortcut `Alt-P` will send the current selection to `p2r`. Note that by default -`--right` is passed and `p2r` is executed in your `bash` environment. You can -edit the Workflow in Alfred if this doesn't work for your setup. +Once installed, you can then use `rm` command and `rmb` (for the `--blank` +pages to insert blank pages between pages for notes) with a URL passed. The +global shortcut `Alt-P` will send the current selection to `p2r`. Note that by +default `--right` is passed and `p2r` is executed in your `bash` environment. +You can edit the Workflow in Alfred if this doesn't work for your setup. ![Alfred Screenshot](https://raw.githubusercontent.com/GjjvdBurg/paper2remarkable/master/.github/alfred.png) @@ -160,8 +170,9 @@ edit the Workflow in Alfred if this doesn't work for your setup. ## Docker -You can also use the Dockerfile to avoid installing dependencies on your -machine. You will need `git` and `docker` installed. +If you'd like to avoid installing the dependencies directly on your machine, +you can use the Dockerfile. To make this work you will need ``git`` and +``docker`` installed. First clone this repository with `git clone` and `cd` inside of it, then build the container: -- cgit v1.2.3 From c68b475ea9c7d11e309d8c997924b9f4f0e44575 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 4 Apr 2020 23:24:30 +0100 Subject: readme spacing --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 5de3ba9..9fdda6b 100644 --- a/README.md +++ b/README.md @@ -137,11 +137,13 @@ Specifically: ``` $ go get -u github.com/juruen/rmapi ``` + 2. Then install system dependencies: - **Arch Linux:** ``pacman -S pdftk ghostscript poppler`` - **Ubuntu:** ``apt-get install pdftk ghostscript poppler-utils``. Replace ``pdftk`` with ``qpdf`` if your distribution doesn't package ``pdftk``. - **MacOs:** ``brew install pdftk-java ghostscript poppler`` (using [HomeBrew](https://brew.sh/)). + 3. Finally, install ``paper2remarkable``: ``` $ pip install paper2remarkable -- cgit v1.2.3 From 90e97824287c192d3d99cae2981cbd35905cb91d Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Wed, 8 Apr 2020 21:21:52 +0100 Subject: Bump version and update changelog --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 9fdda6b..3a3819d 100644 --- a/README.md +++ b/README.md @@ -216,6 +216,10 @@ docker run --rm -v "${HOME}/.rmapi:/home/user/.rmapi:rw" p2r -v https://arxiv.or docker run --rm -v "${HOME}/.rmapi:/home/user/.rmapi:rw" -v "$(pwd):/home/user:r" p2r -v localfile.pdf ``` +For transferring local files using the Docker image, you may find [this helper +function](https://github.com/GjjvdBurg/paper2remarkable/issues/34#issuecomment-610852258) +useful. + You can also create an [alias](http://tldp.org/LDP/abs/html/aliases.html) in your ``~/.bashrc`` file to abstract away the Docker commands: -- cgit v1.2.3 From 3999c7e59dbdf50a35bbf3c6efb9af872befde95 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Wed, 15 Apr 2020 11:18:32 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3a3819d..cf82989 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.6.0 +Paper2reMarkable version 0.6.2 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From cfa9f9170a9cdfad5dbe88f6c76d2f939953724b Mon Sep 17 00:00:00 2001 From: Simon Eskildsen Date: Mon, 27 Apr 2020 08:34:30 -0400 Subject: readme: add printing section --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index cf82989..c74ffe4 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,8 @@ $ p2r https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines The script can be run through the ``p2r`` command line program or via Docker (see below). If you're using MacOS, you might be interested in the [Alfred -workflow](#alfred). On Linux, a background terminal such as -[Guake](http://guake-project.org/) can be very handy. +workflow](#alfred) or [Printing to p2r](#printing). On Linux, a background +terminal such as [Guake](http://guake-project.org/) can be very handy. ``paper2remarkable`` makes it as easy as possible to get a PDF on your reMarkable from any of the following sources: @@ -170,6 +170,23 @@ You can edit the Workflow in Alfred if this doesn't work for your setup. [workflow]: https://github.com/GjjvdBurg/paper2remarkable/blob/master/Remarkable.alfredworkflow?raw=true +## Printing + +Printing to `p2r` allows printing prompts to save directly to your reMarkable +tablet, passing through `p2r` for processing. + +For MacOS, you can follow [the guide][print-guide] for printing with `rmapi`, +but for the bash script, instead use this script: + +``` +for f in "$@" +do + bash -c -l "p2r --right '$f'" +done +``` + +[print-guide]: https://github.com/juruen/rmapi/blob/master/docs/tutorial-print-macosx.md + ## Docker If you'd like to avoid installing the dependencies directly on your machine, -- cgit v1.2.3 From 8e720efe6604306e32875912ca5b1ff5d0fd891c Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Mon, 27 Apr 2020 18:20:34 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c74ffe4..e23c1a3 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.6.2 +Paper2reMarkable version 0.6.3 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From adeda34e6a488192835df1ab1fd56377182e559e Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Tue, 28 Apr 2020 13:35:08 +0100 Subject: Add a comment regarding use without a remarkable --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index e23c1a3..0bbc3ef 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,9 @@ $ p2r https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines The script can be run through the ``p2r`` command line program or via Docker (see below). If you're using MacOS, you might be interested in the [Alfred workflow](#alfred) or [Printing to p2r](#printing). On Linux, a background -terminal such as [Guake](http://guake-project.org/) can be very handy. +terminal such as [Guake](http://guake-project.org/) can be very handy. Note +that even without a reMarkable, this program can make downloading papers +easier (just use the `-n` flag). ``paper2remarkable`` makes it as easy as possible to get a PDF on your reMarkable from any of the following sources: -- cgit v1.2.3 From 9bf3cc745e9bc01cb8e9ed3e8c14407f639b233e Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 2 May 2020 13:05:37 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0bbc3ef..853808f 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.6.3 +Paper2reMarkable version 0.6.4 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From ac387eb56a1c6aa3273571d233ec385d7d6a94f9 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sun, 3 May 2020 22:24:36 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 853808f..4ddcc30 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.6.4 +Paper2reMarkable version 0.6.5 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From 0fdbbdc7f2618bf6830b99591aacab513290ad8b Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Tue, 5 May 2020 11:45:13 +0100 Subject: Add badges to readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4ddcc30..869e501 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # paper2remarkable -[![PyPI -version](https://badge.fury.io/py/paper2remarkable.svg)](https://pypi.org/project/paper2remarkable) +[![PyPI version](https://badge.fury.io/py/paper2remarkable.svg)](https://pypi.org/project/paper2remarkable) +[![Build Status](https://travis-ci.org/GjjvdBurg/paper2remarkable.svg?branch=master)](https://travis-ci.org/GjjvdBurg/paper2remarkable) +[![Downloads](https://pepy.tech/badge/paper2remarkable/month)](https://pepy.tech/project/paper2remarkable/month) ``paper2remarkable`` is a command line program for quickly and easily transferring an academic paper to your [reMarkable](https://remarkable.com/): -- cgit v1.2.3 From 22ed62b8b5918324929abfc19d4798bad4d07a90 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Mon, 11 May 2020 18:00:25 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 869e501..78bb0da 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.6.5 +Paper2reMarkable version 0.6.6 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From b0d61a1a6bffadb01ab62405d4c9a3818a3fec62 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sun, 24 May 2020 21:39:12 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 78bb0da..bd733d6 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.6.6 +Paper2reMarkable version 0.6.7 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From 9deed77ca86c025d3420eef5f34f1894aae3dba2 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sun, 24 May 2020 22:16:25 +0100 Subject: Fix spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index bd733d6..2aa56d7 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ reMarkable from any of the following sources: The program aims to be flexible to the exact source URL, so for many of the academic sources you can either provide a URL to the abstract page or to the -PDF file. If you have an source that you would like to see added to the list, +PDF file. If you have a source that you would like to see added to the list, let me know! ``paper2remarkable`` takes the source URL and: -- cgit v1.2.3 From e298f1cfd64253347ec81cadf5324a32d81ec2e5 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 11 Jul 2020 22:21:55 +0100 Subject: Add semantic scholar to readme --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2aa56d7..7de9c40 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ reMarkable from any of the following sources: * [OpenReview](https://openreview.net/) * [PMLR](http://proceedings.mlr.press/) * [PubMed Central](https://www.ncbi.nlm.nih.gov/pmc/) +* [SemanticScholar](https://www.semanticscholar.org/) * [SpringerLink](https://link.springer.com/) * A generic URL to a PDF file * A local PDF file -- cgit v1.2.3 From 8f6f3c433ce37c0205144b56cd48ea1ecc661e67 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Wed, 15 Jul 2020 16:56:05 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7de9c40..7108c3e 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.6.7 +Paper2reMarkable version 0.6.9 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From 071b5a0f2958c34f1a189259346a8732a1110de2 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Wed, 15 Jul 2020 22:44:33 +0100 Subject: Add provider for SagePub --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 7108c3e..62c2b0b 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ reMarkable from any of the following sources: * [OpenReview](https://openreview.net/) * [PMLR](http://proceedings.mlr.press/) * [PubMed Central](https://www.ncbi.nlm.nih.gov/pmc/) +* [SagePub](https://journals.sagepub.com/) * [SemanticScholar](https://www.semanticscholar.org/) * [SpringerLink](https://link.springer.com/) * A generic URL to a PDF file -- cgit v1.2.3 From 848cbf8bfb82c568c94ff3842ee538dc5c990120 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Wed, 15 Jul 2020 22:55:28 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 62c2b0b..eaec8c4 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.6.9 +Paper2reMarkable version 0.7.0 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From 0e7b27b4e34e52744f6037f78024e1df2ee26a0c Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Tue, 11 Aug 2020 22:18:40 +0100 Subject: Readme formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index eaec8c4..0f23c4f 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Optionally, you can: Here's the full help of the script: -```text +``` usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--filename FILENAME] [--gs GS] [--pdftoppm PDFTOPPM] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] -- cgit v1.2.3 From 3a5260a3a1311bf589fe7a4ef221939f8c9727d1 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Thu, 27 Aug 2020 13:37:33 +0100 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0f23c4f..2cfe192 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.7.0 +Paper2reMarkable version 0.7.1 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From f242e29147ac8ec1450a0bdb90b1dc0da3aa4e85 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sun, 30 Aug 2020 13:20:45 +0100 Subject: Add tentative windows instructions --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2cfe192..8b1db06 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,14 @@ Specifically: - **Arch Linux:** ``pacman -S pdftk ghostscript poppler`` - **Ubuntu:** ``apt-get install pdftk ghostscript poppler-utils``. Replace ``pdftk`` with ``qpdf`` if your distribution doesn't package ``pdftk``. - - **MacOs:** ``brew install pdftk-java ghostscript poppler`` (using [HomeBrew](https://brew.sh/)). + - **MacOS:** ``brew install pdftk-java ghostscript poppler`` (using [HomeBrew](https://brew.sh/)). + - **Windows:** Installers or executables are available for + [qpdf](https://github.com/qpdf/qpdf/releases) (for instance the mingw + binary executables) and + [GhostScript](https://www.ghostscript.com/download/gsdnld.html). + Importantly, Windows support is untested and these are generic + instructions, so we welcome clarifications where needed. The Docker + instructions below may be more convenient on Windows. 3. Finally, install ``paper2remarkable``: ``` -- cgit v1.2.3 From 8999a8e83fdafda758881fbb762ad4d88686ccfc Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 26 Sep 2020 00:24:59 +0200 Subject: Readme updates --- README.md | 118 +++++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 67 insertions(+), 51 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8b1db06..341b588 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,12 @@ $ p2r https://hbr.org/2019/11/getting-your-team-to-do-more-than-meet-deadlines The script can be run through the ``p2r`` command line program or via Docker (see below). If you're using MacOS, you might be interested in the [Alfred -workflow](#alfred) or [Printing to p2r](#printing). On Linux, a background -terminal such as [Guake](http://guake-project.org/) can be very handy. Note -that even without a reMarkable, this program can make downloading papers -easier (just use the `-n` flag). +workflow](#alfred-workflow) or [Printing to p2r](#printing). On Linux, a +background terminal such as [Guake](http://guake-project.org/) can be very +handy. Note that even without a reMarkable, this program can make downloading +papers easier (just use the `-n` flag). + +## Introduction ``paper2remarkable`` makes it as easy as possible to get a PDF on your reMarkable from any of the following sources: @@ -68,43 +70,8 @@ Optionally, you can: - Provide an explicit filename using the ``--filename`` parameter - Specify the location on the reMarkable to place the file (default ``/``) -Here's the full help of the script: - -``` -usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] - [--filename FILENAME] [--gs GS] [--pdftoppm PDFTOPPM] - [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] - input - -Paper2reMarkable version 0.7.1 - -positional arguments: - input URL to a paper or the path of a local PDF file - -optional arguments: - -h, --help show this help message and exit - -b, --blank Add a blank page after every page of the PDF - -c, --center Center the PDF on the page, instead of left align - -d, --debug debug mode, doesn't upload to reMarkable - -n, --no-upload don't upload to the reMarkable, save the output in - current working dir - -p REMARKABLE_DIR, --remarkable-path REMARKABLE_DIR - directory on reMarkable to put the file (created if - missing, default: /) - -r, --right Right align so the menu doesn't cover it - -k, --no-crop Don't crop the pdf file - -v, --verbose be verbose - -V, --version Show version and exit - --filename FILENAME Filename to use for the file on reMarkable - --gs GS path to gs executable (default: gs) - --pdftoppm PDFTOPPM path to pdftoppm executable (default: pdftoppm) - --pdftk PDFTK path to pdftk executable (default: pdftk) - --qpdf QPDF path to qpdf executable (default: qpdf) - --rmapi RMAPI path to rmapi executable (default: rmapi) -``` - -And here's an example with verbose mode enabled that shows everything the -script does by default: +Here's an example with verbose mode enabled that shows everything the script +does by default: ``` $ p2r -v https://arxiv.org/abs/1811.11242 @@ -132,9 +99,6 @@ The script requires the following external programs to be available: manager provides. - [GhostScript](https://www.ghostscript.com/) - [rMAPI](https://github.com/juruen/rmapi) -- Optional: [pdftoppm](https://linux.die.net/man/1/pdftoppm) (recommended for - speed). Usually part of a [Poppler](https://poppler.freedesktop.org/) - installation. Specifically: @@ -162,12 +126,62 @@ Specifically: ``` this installs the ``p2r`` command line program. -If any of the dependencies are not available on the ``PATH`` variable, you can -supply them with the relevant options to the script (for instance ``p2r ---rmapi /path/to/rmapi``). If you run into trouble with the installation, -please let me know! +**Optionally**, you can install: + +- [pdftoppm](https://linux.die.net/man/1/pdftoppm) (recommended for speed). + Usually part of a [Poppler](https://poppler.freedesktop.org/) installation. + +- the [ReadabiliPy](https://github.com/alan-turing-institute/ReadabiliPy) + package with Node.js support, to allow using + [Readability.js](https://github.com/mozilla/readability) for HTML articles. + This is known to improve the output of certain web articles. -## Alfred +If any of the dependencies (such as rmapi or ghostscript) are not available on +the ``PATH`` variable, you can supply them with the relevant options to the +script (for instance ``p2r --rmapi /path/to/rmapi``). If you run into trouble +with the installation, please let me know by opening an issue [on +Github][github-url]. + +## Usage + +The full help of the script is as follows. Hopefully the various command line +flags are self-explanatory, but if you'd like more information, please open an +issue [on GitHub][github-url]. + +``` +usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] + [--filename FILENAME] [--gs GS] [--pdftoppm PDFTOPPM] + [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] + input + +Paper2reMarkable version 0.7.1 + +positional arguments: + input URL to a paper or the path of a local PDF file + +optional arguments: + -h, --help show this help message and exit + -b, --blank Add a blank page after every page of the PDF + -c, --center Center the PDF on the page, instead of left align + -d, --debug debug mode, doesn't upload to reMarkable + -n, --no-upload don't upload to the reMarkable, save the output in + current working dir + -p REMARKABLE_DIR, --remarkable-path REMARKABLE_DIR + directory on reMarkable to put the file (created if + missing, default: /) + -r, --right Right align so the menu doesn't cover it + -k, --no-crop Don't crop the pdf file + -v, --verbose be verbose + -V, --version Show version and exit + --filename FILENAME Filename to use for the file on reMarkable + --gs GS path to gs executable (default: gs) + --pdftoppm PDFTOPPM path to pdftoppm executable (default: pdftoppm) + --pdftk PDFTK path to pdftk executable (default: pdftk) + --qpdf QPDF path to qpdf executable (default: qpdf) + --rmapi RMAPI path to rmapi executable (default: rmapi) +``` + +## Alfred Workflow On MacOS, you can optionally install [this Alfred workflow][workflow]. Alfred is [a launcher for MacOS](https://www.alfredapp.com/). @@ -264,5 +278,7 @@ Then you can use ``paper2remarkable`` from the command line as ``p2r``! License: MIT -If you find a problem or want to suggest a feature, please let us know! You're -helping to make this project better! +If you find a problem or want to suggest a feature, please open an issue [on +Github][github-url]. You're helping to make this project better for everyone! + +[github-url]: https://github.com/GjjvdBurg/paper2remarkable -- cgit v1.2.3 From f02325944489a12b481ca3877cda0b4a44c93203 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 26 Sep 2020 00:55:10 +0200 Subject: Bump version and update changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 341b588..957efe9 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,7 @@ usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] input -Paper2reMarkable version 0.7.1 +Paper2reMarkable version 0.7.2 positional arguments: input URL to a paper or the path of a local PDF file -- cgit v1.2.3 From 13a5a27233c650612253264a2f2818550df8b883 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Tue, 20 Oct 2020 23:26:02 +0200 Subject: Bump version and update changelog --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 957efe9..20a0978 100644 --- a/README.md +++ b/README.md @@ -150,25 +150,25 @@ issue [on GitHub][github-url]. ``` usage: p2r [-h] [-b] [-c] [-d] [-n] [-p REMARKABLE_DIR] [-r] [-k] [-v] [-V] - [--filename FILENAME] [--gs GS] [--pdftoppm PDFTOPPM] - [--pdftk PDFTK] [--qpdf QPDF] [--rmapi RMAPI] - input + [--filename FILENAME] [--gs GS] [--pdftoppm PDFTOPPM] [--pdftk PDFTK] + [--qpdf QPDF] [--rmapi RMAPI] + input [input ...] -Paper2reMarkable version 0.7.2 +Paper2reMarkable version 0.7.3 positional arguments: - input URL to a paper or the path of a local PDF file + input One or more URLs to a paper or paths to local PDF files optional arguments: -h, --help show this help message and exit -b, --blank Add a blank page after every page of the PDF -c, --center Center the PDF on the page, instead of left align -d, --debug debug mode, doesn't upload to reMarkable - -n, --no-upload don't upload to the reMarkable, save the output in - current working dir + -n, --no-upload don't upload to the reMarkable, save the output in current working + dir -p REMARKABLE_DIR, --remarkable-path REMARKABLE_DIR - directory on reMarkable to put the file (created if - missing, default: /) + directory on reMarkable to put the file (created if missing, default: + /) -r, --right Right align so the menu doesn't cover it -k, --no-crop Don't crop the pdf file -v, --verbose be verbose -- cgit v1.2.3 From 14cacacf3fd7b78b287ec7e6b127bd24f0ea4f56 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 23 Oct 2020 17:36:20 +0200 Subject: Add CVF provider --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 20a0978..dfb9be1 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ reMarkable from any of the following sources: * [arXiv](https://arxiv.org/) * [ACM Digital Library](https://dl.acm.org/dl.cfm) * [CiteSeerX](http://citeseerx.ist.psu.edu/index) +* [CVF](https://openaccess.thecvf.com/menu) * [JMLR](http://jmlr.org) * [NBER](https://www.nber.org) * [NeurIPS](https://papers.nips.cc/) -- cgit v1.2.3 From bb43b8e634bab85d6fdff2fa7b47a1884041ae10 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 24 Oct 2020 01:04:29 +0200 Subject: Bump version and update changelog --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dfb9be1..1d74caa 100644 --- a/README.md +++ b/README.md @@ -165,11 +165,9 @@ optional arguments: -b, --blank Add a blank page after every page of the PDF -c, --center Center the PDF on the page, instead of left align -d, --debug debug mode, doesn't upload to reMarkable - -n, --no-upload don't upload to the reMarkable, save the output in current working - dir + -n, --no-upload don't upload to the reMarkable, save the output in current working dir -p REMARKABLE_DIR, --remarkable-path REMARKABLE_DIR - directory on reMarkable to put the file (created if missing, default: - /) + directory on reMarkable to put the file (created if missing, default: /) -r, --right Right align so the menu doesn't cover it -k, --no-crop Don't crop the pdf file -v, --verbose be verbose -- cgit v1.2.3