diff --git a/CONTRIB.md b/CONTRIB.md index ea8ee56..997c0c9 100644 --- a/CONTRIB.md +++ b/CONTRIB.md @@ -9,11 +9,11 @@ This is useful that others can keep track and no time is wasted in doing the sam ## 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. +Master may be regarded as some kind of "nightly"-branch, so usually (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]. +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 diff --git a/INSTALL.md b/INSTALL.md index 9bcfd35..c8d7ac7 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -2,13 +2,13 @@ ## 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). +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-dir +Install Pizza by running "install.sh" from the base-directory. ### The hard way diff --git a/LICENSE b/LICENSE index ec70c90..8edbc1b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013-2014 F3L-Team, Oliver Rümpelein +Copyright (c) 2013-2014 F3L-Team, Oliver Rümpelein, Gesina Schwalbe Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. diff --git a/README.md b/README.md index 0514dad..09641e1 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ 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! +With PIZZA, you may now send pizza (or else) to any mail-address out there! ## Usage ## See INSTALL for prerequisites and details. -To run "pizza" from the bare repository, cd into the src directory and run +To run "pizza" from the bare repository, `cd` into the source directory and run ```bash export PIZZAINC="../assets"; ./pizza @@ -22,3 +22,4 @@ 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! +More information can be found in the LICENSE-file. \ No newline at end of file