Added contribution-manual and rewrote docs with Markdown.

This commit is contained in:
Oliver Rümpelein 2015-01-04 13:20:08 +01:00
parent bd6e2f6bee
commit 7ab2480ce3
5 changed files with 70 additions and 18 deletions

23
CONTRIB.md Normal file
View file

@ -0,0 +1,23 @@
# Contribution
Here are some small rules for contributing to this project, they may be
subject to change:
## Write Issues about your plans
This is useful that others can keep track and no time is wasted in doing the same twice. You may also write me a mail (oli_r@fg4f.de), then I'll do this myself.
## Base your work onto the master-branch
Master may be regarded as some kind of "Nightly"-Branch, so usally (though not always) it contains stable code that is going to get into release.
## Commit FREQUENTLY and WELL-DOCUMENTED
The tips from the [Pro-Git-Book][1] come in Handy here, as well as the [GitLab Flow page][2].
Do things like rebase and stash only if you're absolutely sure what you're doing, and if the code exists nowhere but on your local repo!
## Early Merge-Requests
If you think you're not completely done yet, or if you are stuck at some point: do a merge-request. Merge-Requests are discussions about work, no presentation for the result.
[1]: http://www.git-scm.com/book/en/v2
[2]: https://about.gitlab.com/2014/09/29/gitlab-flow/

View file

@ -1,9 +0,0 @@
==== Installing Pizza ====
For Pizza to work, you need a running mailservice (either server, smarthost or local) using "mailx" from s-nail (provided by, i.e., heirloom-mailx in debian, s-nail in arch). Install Pizza by running "install.sh" from the base-dir, or the following commands as root after cd'ing into the git base directory:
install -m 755 src/pizza /usr/local/bin/pizza
mkdir -p /usr/local/share/pizza
install -m 644 assets/pizza assets/heart /usr/local/share/pizza/
If you want to use another directory than "/usr/local/share/pizza/" for the ASCII-Art-Pics, you have to set the "PIZZAINC"-Variable accordingly.

23
INSTALL.md Normal file
View file

@ -0,0 +1,23 @@
# Installing Pizza
## Prerequisites
For Pizza to work, you need a running mailservice (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-dir
### 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.

9
README
View file

@ -1,9 +0,0 @@
Ever wanted to share a pizza (or else) to anyone who offers a service, for example hosts a data sharing service?
With PIZZA, you may now send pizza (or else) to any mailaddress out there!
Usage: See INSTALL for prerequisites.
To run "pizza" from the bare repository, cd into the src directory and run
export PIZZAINC="../assets"; ./pizza

24
README.md Normal file
View file

@ -0,0 +1,24 @@
# PIZZA
## Send virtual pizza around the world
Ever wanted to share a pizza (or else) to anyone who offers a service, for example hosts a data sharing service?
With PIZZA, you may now send pizza (or else) to any mailaddress out there!
## Usage ##
See INSTALL for prerequisites and details.
To run "pizza" from the bare repository, cd into the src directory and run
```bash
export PIZZAINC="../assets"; ./pizza
```
## Contribution
Take a short look into CONTRIB to get a feeling for the workflow.
## License
Pizza is released under MIT-License, with the ASCII-Art being property of other persons. Due to this, this bundle Pizza is for PRIVATE USE ONLY. In any other case, you may need to switch the pictures!