Skip to content

Commit 76b9873

Browse files
committed
Added documentation on how to use this repository
1 parent 9d466f7 commit 76b9873

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Test Driven Python Development
2+
==============================
3+
4+
This repository contains the code for the book `Test Driven Python Development <http://www.amazon.in/Test-Driven-Python-Development-Siddharta-Govindaraj/dp/1783987928/>`.
5+
6+
How to use this repository
7+
--------------------------
8+
9+
The repository has tags, so you can get the code for the individual chapters by choosing the appropriate tag.
10+
11+
**If you are familiar with using git & github**: Clone this repository, then look at tags to get the point in the code you want to go to. Checkout the appropriate tag on your local repository to get to that particular state of the code.
12+
13+
**If you have not used github before**: Look at the `list of tags <https://github.com/siddhi/test_driven_python/tags>`, and click the *zip link* for the point in the code that you are interested in. This will download the code for that particular commit as a zip file. Unzip this file into your project folder and work from there.
14+
15+
Notes
16+
-----
17+
18+
* Python 2.6+ compatible version of the code is available on it's own branch here - https://github.com/siddhi/test_driven_python/tree/py2.6
19+
* Some readers have submitted contributions to this repository. You can access the code with these contributions in the *contrib* branch - https://github.com/siddhi/test_driven_python/tree/contrib
20+
21+
Submitting contributions
22+
------------------------
23+
24+
If you would like to submit changes to this repository, checkout the *contrib* branch, make changes and submit a pull request. I will be happy to merge the changes in.

0 commit comments

Comments
 (0)