From 051e27a386e9a774b3b1e8c705aa0c8de8e129c3 Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@plope.com>
Date: Sat, 30 Oct 2010 19:46:32 -0400
Subject: Remove setuptools-git setup_requires (inappropriate for deployment),
 add instructions about how to set up a development checkout to HACKING.txt

---
 HACKING.txt | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

(limited to 'HACKING.txt')

diff --git a/HACKING.txt b/HACKING.txt
index 464b653c1..c3a40900d 100644
--- a/HACKING.txt
+++ b/HACKING.txt
@@ -3,6 +3,51 @@ Hacking on Pyramid
 
 Here are some guidelines about hacking on Pyramid.
 
+Using a Development Checkout
+----------------------------
+
+Below is a quick start on creating a development environment using a Pyramid
+checkout.
+
+- Create a new directory somewhere and ``cd`` to it::
+
+  $ mkdir ~/hack-on-pyramid
+  $ cd ~/hack-on-pyramid
+
+- Check out a read-only copy of the Pyramid source::
+
+  $ git clone git://github.com/Pylons/pyramid.git
+
+  (alternately, create a writeable fork on GitHub and check that out).
+
+- Create a virtualenv in which to install Pyramid::
+
+  $ virtualenv2.6 --no-site-packages env
+
+- Install ``setuptools-git`` into the virtualenv (for good measure, as we're
+  using git to do version control)::
+
+  $ env/bin/easy_install setuptools-git
+
+- Install Pyramid from the checkout into the virtualenv using ``setup.py
+  develop`` (running ``setup.py develop`` *must* be done while the current
+  working directory is the ``pyramid`` checkout directory)::
+
+  $ cd pyramid
+  $ ../env/bin/python setup.py develop
+
+- At that point, you should be able to create new Pyramid projects by using
+  ``paster create``::
+
+  $ cd ../env
+  $ bin/paster create -t pyramid_starter starter
+
+- And install those projects (also using ``setup.py develop``) into the
+  virtualenv::
+
+  $ cd starter
+  $ ../bin/python setup.py develop
+
 Adding Features
 ---------------
 
-- 
cgit v1.2.3