]> git.saurik.com Git - wxWidgets.git/blob - wxPython/docs/README.html
Adding overview docs and a couple tweaks to the demo.
[wxWidgets.git] / wxPython / docs / README.html
1 <?xml version="1.0" encoding="iso-8859-1" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
6 <meta name="generator" content="Docutils 0.4.1: http://docutils.sourceforge.net/" />
7 <title></title>
8 <link rel="stylesheet" href="default.css" type="text/css" />
9 </head>
10 <body>
11 <div class="document">
12 <div class="section">
13 <h1><a id="wxpython-readme" name="wxpython-readme">wxPython README</a></h1>
14 <p>Welcome to the wonderful world of wxPython!</p>
15 <p>So where do you go from here? The best thing to do is to run the demo
16 and use its source code to help you learn how to use wxPython. Most
17 of the classes available are demonstrated there, and you can view the
18 sources directly in the demo so it is designed to help you learn. If
19 you are on Windows or OS X then you can run the demo just by double
20 clicking it's icon. If you are on Linux/Unix then change to the
21 directory containing the demo and type:</p>
22 <blockquote>
23 python demo.py</blockquote>
24 <p>There are also some sample mini applications available for you to run
25 and to play with as a learning exercise.</p>
26 <p>The next thing you should do is join the wxPython-users maillist where
27 you can interact with a community of other users and developers who
28 are willing to help you learn, answer questions and solve problems.
29 To join the mail list just go to this web page and follow the
30 instructions there:</p>
31 <blockquote>
32 <a class="reference" href="http://wxpython.org/maillist.php">http://wxpython.org/maillist.php</a></blockquote>
33 <p>There is also a good set of class reference documentation available
34 for wxPython, but currently it is geared for the C++ user. This may
35 be a little daunting at first, but with a little practice you'll
36 easily be able to &quot;mentally translate&quot; from the C++ shown into Python.
37 (See <a class="reference" href="http://wiki.wxpython.org/index.cgi/C_2b_2bGuideForwxPythoneers">http://wiki.wxpython.org/index.cgi/C_2b_2bGuideForwxPythoneers</a>
38 for a little help on this process.) Not all classes documented are
39 available in Python, but most of the GUI related classes are.</p>
40 </div>
41 <div class="section">
42 <h1><a id="other-info" name="other-info">Other Info</a></h1>
43 <p>Please also see the following files:</p>
44 <blockquote>
45 <dl class="docutils">
46 <dt>docs/CHANGES.txt Information about new features, fixes,</dt>
47 <dd>etc. in each release.</dd>
48 <dt>docs/BUILD.txt Instructions for building wxPython on</dt>
49 <dd>various Unix-like platforms, OS X or
50 Windows.</dd>
51 <dt>docs/MigrationGuide.txt Information about some big changes from 2.4</dt>
52 <dd>to 2.5 that require changes to your
53 applications</dd>
54 </dl>
55 <p>licence/* Text of the wxWidgets license.</p>
56 </blockquote>
57 <p>--
58 Robin Dunn
59 <a class="reference" href="mailto:robin&#64;alldunn.com">robin&#64;alldunn.com</a></p>
60 </div>
61 </div>
62 </body>
63 </html>