personal/longNowForMd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Change readme slightly

Browse Source
This commit is contained in:
NunoSempere 2021-06-28 16:41:43 +02:00
parent 49673f4b81
commit e3a95ec647
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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
```