diff options
| -rw-r--r-- | CONTRIBUTING.md | 20 | ||||
| -rw-r--r-- | DEVELOPERS.md | 1 |
2 files changed, 16 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 ------- diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 00e5d41..c39c755 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -16,6 +16,7 @@ This all depends on a `gh-pages` branch: First build the distribution: + ./configure make distcheck On any system you can build the tarball, Homebrew package, Arch |