From f80e2eec18afb4cdf8fd925fc531b7f778ba8c37 Mon Sep 17 00:00:00 2001
From: Martin Frost <frost@ceri.se>
Date: Thu, 1 Jan 2015 21:53:05 +0100
Subject: Improve setup documentation

Improve the `CONTRIBUTING.md` documentation about what dependencies
exist, how to install them, and how to get started in general. Remind
developers about the `configure` script, because without it no
`Makefile` will exist.
---
 CONTRIBUTING.md | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

(limited to 'CONTRIBUTING.md')

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7b00399..475c288 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,11 +4,6 @@ Contributing
 Overview
 --------
 
-- Fork the repo.
-- Prepare the build system: `./autogen.sh`. (This depends on GNU autoconf and
-  GNU automake.)
-- Configure the package: `./configure`.
-- Make sure the tests pass: `make check`.
 - Make your changes.
 - Update `NEWS.md.in`.
 - Update `.mailmap` if necessary.
@@ -37,6 +32,21 @@ it in the commit message (`Fixes #42.`).
 
 [mailmap]: https://github.com/git/git/blob/master/Documentation/mailmap.txt
 
+Setup
+-----
+
+1. Fork the repo.
+2. Install dependencies
+
+  - Cram is used for tests: `pip install cram`
+  - The mustache gem for building the HTML pages: `gem install mustache`
+
+3. Prepare the build system: `./autogen.sh`. (This depends on GNU
+   autoconf and GNU automake.)
+4. Configure the package: `./configure`.
+5. Make sure the tests pass: `make check`.
+6. Start hacking
+
 Testing
 -------
 
-- 
cgit v1.2.3