aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2019-11-11 17:11:14 +0000
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2019-11-11 17:11:14 +0000
commite894e7cfe0ca88be292eb97207ffbd738f2d568f (patch)
tree9279e461bcaca826f10d3777f08221699658ddb2
parentMerge branch 'ClaytonJY-shrink-dockerfile' (diff)
downloadpaper2remarkable-e894e7cfe0ca88be292eb97207ffbd738f2d568f.tar.gz
paper2remarkable-e894e7cfe0ca88be292eb97207ffbd738f2d568f.zip
Add note on creating an alias for the docker command
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 763f5ec..e4f4c18 100644
--- a/README.md
+++ b/README.md
@@ -162,10 +162,21 @@ Use the container by replacing `p2r` with `docker run --rm -v
# print help and exit
docker run --rm -v "${HOME}/.rmapi:/home/user/.rmapi:rw" p2r --help
-# equivalent to above usage via `python`
+# equivalent to above usage
docker run --rm -v "${HOME}/.rmapi:/home/user/.rmapi:rw" p2r -v https://arxiv.org/abs/1811.11242
```
+You can also create an [alias](http://tldp.org/LDP/abs/html/aliases.html) in
+your ``~/.bashrc`` file to abstract away the Docker commands:
+
+```bash
+# in ~/.bashrc
+
+alias p2r="docker run --rm -v \"${HOME}/.rmapi:/home/user/.rmapi:rw\" p2r"
+```
+
+Then you can use ``paper2remarkable`` from the command line as ``p2r``!
+
# Notes
License: MIT