Added install instructions.

This commit is contained in:
Bastian Kleineidam 2014-01-24 22:53:35 +01:00
parent 4386384ba4
commit 7b07964ca8
3 changed files with 25 additions and 0 deletions

View file

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

View file

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

23
doc/install.txt Normal file
View file

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