]> git.saurik.com Git - wxWidgets.git/blame - wxPython/docs/README.html
regenerated the ReST docs
[wxWidgets.git] / wxPython / docs / README.html
CommitLineData
8eda5e35
RD
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" />
c66cd08a
RD
6<meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
7<title></title>
8eda5e35
RD
8<link rel="stylesheet" href="default.css" type="text/css" />
9</head>
10<body>
11<div class="document">
12<div class="section" id="wxpython-readme">
13<h1><a 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
16and use its source code to help you learn how to use wxPython. Most
17of the classes available are demonstrated there, and you can view the
18sources directly in the demo so it is designed to help you learn. If
19you are on Windows or OS X then you can run the demo just by double
20clicking it's icon. If you are on Linux/Unix then change to the
21directory containing the demo and type:</p>
22<blockquote>
23python demo.py</blockquote>
24<p>There are also some sample mini applications available for you to run
25and to play with as a learning exercise.</p>
26<p>The next thing you should do is join the wxPython-users maillist where
27you can interact with a community of other users and developers who
28are willing to help you learn, answer questions and solve problems.
29To join the mail list just go to this web page and follow the
30instructions 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
34for wxPython, but currently it is geared for the C++ user. This may
35be a little daunting at first, but with a little practice you'll
36easily 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>
38for a little help on this process.) Not all classes documented are
39available in Python, but most of the GUI related classes are.</p>
40</div>
41<div class="section" id="other-info">
42<h1><a name="other-info">Other Info</a></h1>
43<p>Please also see the following files:</p>
44<blockquote>
c66cd08a 45<dl class="docutils">
8eda5e35
RD
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
50Windows.</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
53applications</dd>
54</dl>
fc33e5e1 55<p>licence/* Text of the wxWidgets license.</p>
8eda5e35
RD
56</blockquote>
57<p>--
58Robin Dunn
59<a class="reference" href="mailto:robin&#64;alldunn.com">robin&#64;alldunn.com</a></p>
60</div>
61</div>
8eda5e35
RD
62</body>
63</html>