summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGravatar Martin Frost <frost@ceri.se>2015-01-01 21:53:05 +0100
committerGravatar Mike Burns <mike@mike-burns.com>2015-01-07 16:02:45 +0100
commitf80e2eec18afb4cdf8fd925fc531b7f778ba8c37 (patch)
tree7301c9ddfb19d382e83f2b196339022f2f98f937 /CONTRIBUTING.md
parent68128feb0c102a728965b863c4c59a1bac5a092b (diff)
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.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md20
1 files changed, 15 insertions, 5 deletions
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
-------