From e2d9e1b5c265ed4ddb93b873b50df47848008a9c Mon Sep 17 00:00:00 2001
From: Michael DeHaan <michael@ansibleworks.com>
Date: Sat, 20 Apr 2013 09:33:52 -0400
Subject: [PATCH] Convert 'hacking' instructions to markdown, add more info.

---
 hacking/README    |  6 ------
 hacking/README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+), 6 deletions(-)
 delete mode 100644 hacking/README
 create mode 100644 hacking/README.md

diff --git a/hacking/README b/hacking/README
deleted file mode 100644
index 9e35f930d50..00000000000
--- a/hacking/README
+++ /dev/null
@@ -1,6 +0,0 @@
-The 'env-setup' script modifies your environment to allow you to run
-ansible from a git checkout.
-
-To use it from the root of a checkout:
-
-    $ source ./hacking/env-setup
diff --git a/hacking/README.md b/hacking/README.md
new file mode 100644
index 00000000000..7f0267d648b
--- /dev/null
+++ b/hacking/README.md
@@ -0,0 +1,48 @@
+'Hacking' directory tools
+=========================
+
+Env-setup
+---------
+
+The 'env-setup' script modifies your environment to allow you to run
+ansible from a git checkout using python 2.6+.  (You may not use
+python 3 at this time).
+
+First, set up your environment to run from the checkout:
+
+    $ source ./hacking/env-setup
+
+You will need some basic prerequisites installed.  If you do not already have them
+and do not wish to install them from your operating system package manager, you
+can install them from pip
+
+    $ easy_install pip               # if pip is not already available
+    $ pip install pyyaml jinja2
+
+From there, follow ansible instructions on ansible.cc/docs as normal.
+
+Module-formatter
+----------------
+
+The module formatter is a script used to generate manpages and online
+module documentation.
+
+Authors
+-------
+
+'authors' is a simple script that generates a list of everyone who has
+contributed code to the ansible repository.
+
+Test-module
+-----------
+
+'test-module' is a simple program that allows module developers (or testers) to run
+a module outside of the ansible program, locally, on the current machine.
+
+Example:
+
+    $ ./hacking/test-module -m library/shell -a "echo hi"
+
+This is a good way to insert a breakpoint into a module, for instance.
+
+