From 2370d0b783280a02a11cd95155698bd293782540 Mon Sep 17 00:00:00 2001 From: Olivier Mangin Date: Wed, 5 Jul 2017 16:12:02 -0400 Subject: [PATCH] [readme] Adds a short install section to the README. --- readme.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/readme.md b/readme.md index 067f0ac..9a21a46 100644 --- a/readme.md +++ b/readme.md @@ -13,6 +13,17 @@ Pubs is built with the following principles in mind: **Notice:** pubs is still in early development; you should regularly make backups of your pubs repository. +## Installation + +Until pubs is uploaded to Pypi, the standard way to install it is to clone the repository and call `setup.py`. + + git clone https://github.com/pubs/pubs.git + cd pubs + sudo python setup.py install # remove sudo and add --user for local installation instead + +Alternatively Arch Linux users can also use the [pubs-git](https://aur.archlinux.org/packages/pubs-git/) AUR package. + + ## Getting started Create your library (by default, goes to '~/.pubs/').