From e3a95ec6473a1f3faad22d471fe6f3e098cd4a13 Mon Sep 17 00:00:00 2001 From: NunoSempere Date: Mon, 28 Jun 2021 16:41:43 +0200 Subject: [PATCH] Change readme slightly --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 472ae9f..8207e71 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ -This package takes a markdown file, and creates a new markdown file in which each link is accompanied by an archive.org link, in the format [...](original link) ([a](archive.org link)) +This package takes a markdown file, and creates a new markdown file in which each link is accompanied by an archive.org link, in the format [...](original link) ([a](archive.org link)). ## How to install -Copy [this file](https://github.com/NunoSempere/longNowForMd/blob/master/longnowformd.sh) to your .bashrc file, or, for Ubuntu distributions 20.04 (Focal Fossa) and above: +Several different ways: +- Add [this file](https://github.com/NunoSempere/longNowForMd/blob/master/longnowformd.sh) to your path, for instance by moving it to the `/usr/bin` folder and giving it execute permissions, or +- copy its functions into your .bashrc file, or +- for Ubuntu distributions 20.04 (Focal Fossa) and above: ``` $ sudo add-apt-repository ppa:nunosempere/longnowformd @@ -9,6 +12,8 @@ $ sudo apt-get update $ sudo apt install longnowformd ``` +This uses the [nunosempere/longnowformd](https://launchpad.net/~nunosempere/+archive/ubuntu/longnowformd) PPA (Personal Package Archive) + This utility requires [archivenow](https://github.com/oduwsdl/archivenow) as a dependency, which itself requires a python installation. It can be installed with ``` @@ -18,5 +23,5 @@ $ pip install archivenow ## respectively, pip3 ## How to use ``` -$ longnow test.md +$ longnow file.md ```