From c2a344fed14d5a4c754b95acc5674fc9a9a98117 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Wed, 10 Oct 2018 01:54:51 +0200 Subject: [PATCH] documentation: move installation instructions from README.md to doc/install.md --- README.md | 70 +++++++------------------------------------------- doc/install.md | 56 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+), 61 deletions(-) create mode 100644 doc/install.md diff --git a/README.md b/README.md index 0720dad..0aa7fe4 100644 --- a/README.md +++ b/README.md @@ -40,13 +40,17 @@ updating from btrbk <= v0.22.2. Installation ============ -btrbk comes as a single executable file (perl script), without the -need of any installation procedures. If you want the package and -man-pages properly installed, follow the instructions below. +Btrbk is a single perl script, and does not require any special +installation procedures or libraries. Simply download the latest +[btrbk source tarball] and run the "btrbk" executable. + +For more information, read the [installation documentation]. + + [btrbk source tarball]: https://digint.ch/download/btrbk/releases/ + [installation documentation]: doc/install.md -Prerequisites -------------- +### Prerequisites * [btrfs-progs]: Btrfs filesystem utilities >= v3.18.2 * [Perl interpreter]: Probably already installed on your system @@ -59,62 +63,6 @@ Prerequisites [Pipe Viewer]: https://www.ivarch.com/programs/pv.shtml -Instructions ------------- - -In order to install the btrbk executable along with the man-pages and -an example configuration file, choose one of the following methods: - - -### Generic Linux System - -Download and unpack the newest stable [btrbk source tarball] and type: - - sudo make install - - -### Gentoo Linux - -btrbk is in portage: - - emerge app-backup/btrbk - - -### Debian Based Distros - -btrbk is in `stretch (testing) (utils)`: https://packages.debian.org/stretch/btrbk - -Packages are also available via NeuroDebian: http://neuro.debian.net/pkgs/btrbk.html - - -### Fedora Linux - -btrbk is in the official Fedora repos: https://apps.fedoraproject.org/packages/btrbk - - sudo dnf install btrbk - - -### Arch Linux - -btrbk is in AUR: https://aur.archlinux.org/packages/btrbk/ - - -### Alpine Linux - -btrbk is in `testing`, install with: - - apk add btrbk - -### Void Linux - -btrbk is in Void's `current` repository - - xbps-install -S btrbk - - - [btrbk source tarball]: https://digint.ch/download/btrbk/releases/ - - Synopsis ======== diff --git a/doc/install.md b/doc/install.md new file mode 100644 index 0000000..bf4db2f --- /dev/null +++ b/doc/install.md @@ -0,0 +1,56 @@ +Installation +============ + +Btrbk is a single perl script, and does not require any special +installation procedures or libraries. In order to install the btrbk +executable along with the documentation and an example configuration +file, choose one of the following methods: + + +### Generic Linux System + +Download and unpack the latest [btrbk source tarball] and type: + + sudo make install + + +### Gentoo Linux + +btrbk is in portage: + + emerge app-backup/btrbk + + +### Debian Based Distros + +btrbk is in `stretch (testing) (utils)`: https://packages.debian.org/stretch/btrbk + +Packages are also available via NeuroDebian: http://neuro.debian.net/pkgs/btrbk.html + + +### Fedora Linux + +btrbk is in the official Fedora repos: https://apps.fedoraproject.org/packages/btrbk + + sudo dnf install btrbk + + +### Arch Linux + +btrbk is in AUR: https://aur.archlinux.org/packages/btrbk/ + + +### Alpine Linux + +btrbk is in `testing`, install with: + + apk add btrbk + +### Void Linux + +btrbk is in Void's `current` repository + + xbps-install -S btrbk + + + [btrbk source tarball]: https://digint.ch/download/btrbk/releases/