Skip to content

Commit a86e2a4

Browse files
improve wording, add links, etc..
1 parent 55cdce7 commit a86e2a4

File tree

1 file changed

+35
-11
lines changed

1 file changed

+35
-11
lines changed

README.rst

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
Python Koans
33
============
44

5-
Python Koans is a port of Edgecase's "Ruby Koans".
5+
Python Koans is a port of Edgecase's "Ruby Koans" which can be found at http://rubykoans.com/.
66

77
.. image:: http://i442.photobucket.com/albums/qq150/gregmalcolm/PythonKoansScreenshot.png
88

9-
Python Koans is an interactive tutorial for learning Python by making tests pass.
9+
Python Koans is an interactive tutorial for learning the Python programming language by making tests pass.
1010

1111
Most tests are 'fixed' by filling the missing parts of assert functions. Eg:
1212

@@ -28,7 +28,7 @@ Python Koans is available through git on Github:
2828

2929
http://github.com/gregmalcolm/python_koans
3030

31-
It is also mirrored on bitbucket for Mercurial users :
31+
It is also mirrored on bitbucket for Mercurial users:
3232

3333
http://bitbucket.org/gregmalcolm/python_koans
3434

@@ -38,20 +38,29 @@ Either site will allow you to download the source as a zip/gz/bz2.
3838
Installing Python Koans
3939
-----------------------
4040

41-
Aside from downloading or checking out the latest version of Python Koans, all you need to install is Python.
41+
Aside from downloading or checking out the latest version of Python Koans, you need to install the Python interpreter.
4242

43-
At this time of writing there are two versions of the koans, one for use with Python 2.6 and one for Python 3.1. You should be able to work with newer Python versions, but older ones will likely give you problems.
43+
At this time of writing, there are two versions of the Python Koans:
44+
45+
* one for use with Python 2.6 (it also works with Python 2.7)
46+
* one for Python 3.1.
47+
48+
You should be able to work with newer Python versions, but older ones will likely give you problems.
4449

4550
You can download Python from here:
4651

4752
http://www.python.org/download
4853

49-
On installing Python make sure the folder containing the python executable is in the system path. In other words, you need to be able to be able to run Python from a command console. With Python 2 it will be called 'python' or 'python.exe' depending on the operating system. For Python 3 it will either be 'python3' or for windows it will be 'python.exe'.
54+
After installing Python make sure the folder containing the python executable is in the system path. In other words, you need to be able to be able to run Python from a command console. With Python 2 it will be called 'python' or 'python.exe' depending on the operating system. For Python 3 it will either be 'python3' or for windows it will be 'python.exe'.
5055

5156
If you have problems, this may help:
5257

5358
http://www.python.org/about/gettingstarted
5459

60+
Windows users may also want to update the line in the batch file run.bat to set the python path:
61+
62+
SET PYTHON_PATH=C:\Python27
63+
5564

5665
Getting Started
5766
---------------
@@ -107,26 +116,41 @@ Quoting the Ruby Koans instructions::
107116
moment and reflect upon the test to see what it is teaching you
108117
and improve the code to better communicate its intent (refactor)."
109118

119+
110120
Content
111121
-------
112122

113-
Python is a made up of about 2/3 Ruby Koans ported material and 1/3 Python specific tests. The content ported from Ruby Koans includes all the assignment projects.
123+
The Python Koans is a made up of about 2/3 Ruby Koans ported material and 1/3 Python specific tests. The content ported from Ruby Koans includes all the assignment projects.
114124

115-
Content for Python 3 is a little different to the Python 2 flavor due to big changes between the 2 different languages. For example in the Python 2 variant the differences between old and new style classes are covered. This loses relevance in in the Python 3 version, but there are some extra tests covering new functionality.
125+
Content for Python 3 is a little different to the Python 2 flavor due to big changes between the two different versions of the language For example, in the Python 2 variant the differences between old and new style classes are covered. This loses relevance in in the Python 3 version, but there are some extra tests covering new functionality.
116126

117127

118128
Finding More Koan Projects
119129
--------------------------
120130

121-
Right now there are a lot of spinoff Koan projects out there for a great number of languages and frameworks. Many of them do not have that much content, but contributing to them is a great way to learn. At the moment most of them can be found by searching for 'koans' on github.
131+
Right now there are a lot of spinoff Koan projects out there for a great number of languages and frameworks. Many of them do not have that much content, but contributing to them is a great way to learn. At the moment, most of them can be found by searching for 'koans' on github.
132+
133+
A couple of promising projects include:
134+
135+
* C# Koans - https://bitbucket.org/srtsolutions/csharpkoans
136+
Mentioned here: http://labs.srtsolutions.com/c-koans
137+
138+
* F# Koans - https://github.com/ChrisMarinos/FSharpKoans
139+
Mentioned here: http://labs.srtsolutions.com/f-koans
140+
141+
* Scala Koans - http://scalakoans.org/
142+
Mentioned here: http://labs.srtsolutions.com/koans
122143

123-
A couple of promising projects include DotNetKoans and TestMongoKoans.
144+
* DotNetKoans - https://github.com/CoryFoy/DotNetKoans
145+
Mentioned here: http://blog.coryfoy.com/2009/12/dotnet-koans/
146+
147+
* TestMongoKoans.
124148

125149

126150
Acknowledgments
127151
---------------
128152

129-
Thanks go to Jim Weirich and Joe O'Brien for the original Ruby Koans that Python Koans is based on! Also the Ruby Koans in turn borrows from Metakoans so thanks also go to Ara Howard for that!
153+
Thanks go to Jim Weirich and Joe O'Brien for the original Ruby Koans that the Python Koans is based on! Also the Ruby Koans in turn borrows from Metakoans so thanks also go to Ara Howard for that!
130154

131155
Also thanks to everyone who helped with the Python Koans conversion! In particular I got a great headstart on the project by forking from this Python Koans startup project:
132156

0 commit comments

Comments
 (0)