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