From 6df9e4503a3827a777cf9e77576fb5ffb5faeddd Mon Sep 17 00:00:00 2001 From: Daniel Bosk Date: Sun, 20 Dec 2015 12:43:40 +0100 Subject: [PATCH] Improves build and contribution instructions --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cf6bc19..1ba9eec 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,10 @@ maintainer is [Daniel Bosk][dbosk]. The latest release can be found under File Structure and Building ------------------------------------------------------------------------------- -To build the PDF, you must download the source code and its required +*To build* the PDF, after cloning the repository you must clone its required submodules: ```shell -$ git clone git@github.com:dbosk/pricomlab.git $ git submodule update --recursive --init $ make ``` @@ -38,3 +37,9 @@ The source files are structured as follows: - `pricomlab.bib` contains the bibliography entries, thus this file can be included along with the reading instructions. +*To contribute*, please [fork the repository][ForkARepo], make your changes, +commit them and then create a [pull request][PullRequest] in the original +repository. + +[ForkARepo]: https://help.github.com/articles/fork-a-repo/ +[PullRequest]: https://help.github.com/articles/using-pull-requests/