From 7b07964ca8996c5580999d0518ff06a357017780 Mon Sep 17 00:00:00 2001 From: Bastian Kleineidam Date: Fri, 24 Jan 2014 22:53:35 +0100 Subject: [PATCH] Added install instructions. --- Makefile | 1 + doc/changelog.txt | 1 + doc/install.txt | 23 +++++++++++++++++++++++ 3 files changed, 25 insertions(+) create mode 100644 doc/install.txt diff --git a/Makefile b/Makefile index a4a7e7e6f..10ca8e637 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,5 @@ # This Makefile is only used by developers. +# See doc/install.txt on how to install dosage PYTHON:=python VERSION:=$(shell $(PYTHON) setup.py --version) MAINTAINER:=$(shell $(PYTHON) setup.py --maintainer) diff --git a/doc/changelog.txt b/doc/changelog.txt index 9c3dcdec3..f417818a8 100644 --- a/doc/changelog.txt +++ b/doc/changelog.txt @@ -3,6 +3,7 @@ Dosage 2.12 (released xx.xx.2014) Changes: - cmdline: The --basepath option now replaces "~" or "~user" with the users home directory. +- documentation: Added install instructions at doc/install.txt Fixes: - comics: Fix DemolitionSquad. diff --git a/doc/install.txt b/doc/install.txt new file mode 100644 index 000000000..2690c5176 --- /dev/null +++ b/doc/install.txt @@ -0,0 +1,23 @@ +Installation +------------- +The easy way with pip: + +```shell +pip install dosage +``` + +You can invoke Dosage directly from the source code as +`./dosage`. Alternatively, +you can install Dosage using python distutils by invoking +setup.py in the root of the distribution. For example: + +```shell +python setup.py install +``` + +or if you do not have root permissions: + +```shell +python setup.py install --home=$HOME +``` +