pizza/INSTALL.md

# Installing Pizza

## Prerequisites

For Pizza to work, you need a running mail service (either server, smarthost or local) using "mailx" from nail (provided by, i.e., heirloom-mailx in debian, s-nail in arch).

## Installation

### The simple way

Install Pizza by running "install.sh" from the base-directory.
install.sh takes two arguments: a prefix (the path where to place the executable parts; defaults to "/usr/local/") and
an incprefix (the path where to place the message contents/ASCII-images; defaults to "<prefix>/share").
To set incprefix, passing prefix beforehands is mandatory!
You may also pass the environement variables "$PATH" and "$INCPATH", even though given arguments take precedence.

### The hard way

If you have `$SCRIPTDIR` and `$SHAREDIR`, you may also run the following commands from the src-base:

```bash
install -m 755 src/pizza $SCRIPTDIR/pizza
mkdir -p $SHAREDIR/pizza
install -m 644 assets/* $SHAREDIR/pizza/
```

Afterwards, you have to set the variable `$PIZZAINC` to `$SHAREDIR` accordingly.
Added contribution-manual and rewrote docs with Markdown. 2015-01-04 13:20:08 +01:00			`# Installing Pizza`

			`## Prerequisites`

Minor typos fixed. 2015-01-07 13:28:36 +01:00			`For Pizza to work, you need a running mail service (either server, smarthost or local) using "mailx" from nail (provided by, i.e., heirloom-mailx in debian, s-nail in arch).`
Added contribution-manual and rewrote docs with Markdown. 2015-01-04 13:20:08 +01:00
			`## Installation`

			`### The simple way`

Minor typos fixed. 2015-01-07 13:28:36 +01:00			`Install Pizza by running "install.sh" from the base-directory.`
Modified INSTALL.md - Point out the difference between passing path/incpath as arguments and as variables 2015-03-31 15:29:06 +02:00			`install.sh takes two arguments: a prefix (the path where to place the executable parts; defaults to "/usr/local/") and`
			`an incprefix (the path where to place the message contents/ASCII-images; defaults to "<prefix>/share").`
			`To set incprefix, passing prefix beforehands is mandatory!`
			`You may also pass the environement variables "$PATH" and "$INCPATH", even though given arguments take precedence.`
Added contribution-manual and rewrote docs with Markdown. 2015-01-04 13:20:08 +01:00
			`### The hard way`

			If you have `$SCRIPTDIR` and `$SHAREDIR`, you may also run the following commands from the src-base:

			```bash
			`install -m 755 src/pizza $SCRIPTDIR/pizza`
			`mkdir -p $SHAREDIR/pizza`
			`install -m 644 assets/* $SHAREDIR/pizza/`
			```

Fixes #7 - Introduces a second argument "INCPREFIX" used for assets - Updated INSTALL.md 2015-03-29 15:56:10 +02:00			Afterwards, you have to set the variable `$PIZZAINC` to `$SHAREDIR` accordingly.