diff --git a/README.md b/README.md index 1d16415..d79ae84 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,10 @@ - [Features](#features) - [Installation](#installation) - [Dependencies](#dependencies) - - [Installing with a package manager](#installing-with-a-package-manager) - - [Installing from this repository](#installing-from-this-repository) - - [Running as a standalone utility](#running-as-a-standalone-utility) - - [Release packages](#release-packages) + - [From a package manager](#from-a-package-manager) + - [Release packages](#release-packages) + - [From source](#from-source) + - [Running standalone](#running-standalone) - [Shell completion](#shell-completion) - [Usage](#usage) - [Cmdline options](#cmdline-options) @@ -96,7 +96,7 @@ or on Ubuntu: $ sudo apt-get install python3-urllib3 python3-cryptography python3-bs4 python3-requests -#### Installing with a package manager +#### From a package manager - [AUR](https://aur.archlinux.org/packages/buku/) - [Debian](https://packages.debian.org/search?keywords=buku&searchon=names&exact=1) @@ -107,7 +107,11 @@ or on Ubuntu: - [Ubuntu PPA](https://launchpad.net/~twodopeshaggy/+archive/ubuntu/jarun/) - [Void Linux](https://github.com/voidlinux/void-packages/tree/master/srcpkgs/buku) (`sudo xbps-install -S buku`) -#### Installing from this repository +#### Release packages + +Packages for Arch Linux, CentOS, Fedora and Ubuntu are available with the [latest stable release](https://github.com/jarun/Buku/releases/latest). + +#### From source If you have git installed, clone this repository. Otherwise download the [latest stable release](https://github.com/jarun/Buku/releases/latest) or [development version](https://github.com/jarun/Buku/archive/master.zip) (*risky*). @@ -118,19 +122,16 @@ Install to default location (`/usr/local`): To remove, run: $ sudo make uninstall -`PREFIX` is supported. You may need to use `sudo` with `PREFIX` depending on your permissions on destination directory. -##### Running as a standalone utility +`PREFIX` is supported, in case you want to install to a different location. + +#### Running standalone `buku` is a standalone utility. From the containing directory, run: $ chmod +x buku.py $ ./buku.py -##### Release packages - -Packages for Arch Linux, CentOS, Fedora and Ubuntu are available with the [latest stable release](https://github.com/jarun/Buku/releases/latest). - ### Shell completion Shell completion scripts for Bash, Fish and Zsh can be found in respective subdirectories of [auto-completion/](https://github.com/jarun/Buku/blob/master/auto-completion). Please refer to your shell's manual for installation instructions.