From 32053cda010fb70e841ecded0d8c0f6857f48277 Mon Sep 17 00:00:00 2001 From: Magnar Sveen Date: Sun, 30 Sep 2012 13:28:51 +0200 Subject: [PATCH] Update readme with development notes. --- README.md | 15 +++++++++++++++ readme-postfix.md | 15 +++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/README.md b/README.md index 44f4449..e037237 100644 --- a/README.md +++ b/README.md @@ -197,6 +197,21 @@ or with `!compare-fn` if that's non-nil. (!contains? '(1 2 3) 4) ;; => nil ``` +## Development + +Run the tests with + + ./run-tests.sh + +Create the docs with + + ./create-docs.sh + +I highly recommend that you install these as a pre-commit hook, so that +the tests are always running and the docs are always in sync: + + cp pre-commit.sh .git/hooks/pre-commit + ## License Copyright (C) 2012 Magnar Sveen, Joel McCracken diff --git a/readme-postfix.md b/readme-postfix.md index 2134443..d0e6247 100644 --- a/readme-postfix.md +++ b/readme-postfix.md @@ -1,3 +1,18 @@ +## Development + +Run the tests with + + ./run-tests.sh + +Create the docs with + + ./create-docs.sh + +I highly recommend that you install these as a pre-commit hook, so that +the tests are always running and the docs are always in sync: + + cp pre-commit.sh .git/hooks/pre-commit + ## License Copyright (C) 2012 Magnar Sveen, Joel McCracken