wxWidgets/wxPython/docs
Robin Dunn 4c327c7a75 Optionally upload the docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@34038 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2005-05-13 00:56:08 +00:00
..
bin Optionally upload the docs 2005-05-13 00:56:08 +00:00
screenshots Removed some old, outdated, unfinished, or unstarted docs and the 2004-03-26 21:56:14 +00:00
xml Documentation fixes, patch 1179223 by Andreas Mohr 2005-04-08 14:34:30 +00:00
.cvsignore Added XML simplification scripts for generating the wxPython metadata xml. 2003-12-23 17:45:54 +00:00
BUILD.html regenerated the ReST docs 2005-05-09 23:17:49 +00:00
BUILD.txt Add --with-gnomeprint and fix some typos 2005-05-09 23:13:48 +00:00
CHANGES.html regenerated the ReST docs 2005-05-09 23:17:49 +00:00
CHANGES.txt Added wx.lib.hyperlink from Andrea Gavana. It is a control like 2005-05-13 00:27:02 +00:00
default.css wxPython Merge #2 of 2.4 branch --> HEAD (branch tag: wxPy_2_4_merge_2) 2003-07-02 23:13:10 +00:00
docutils.conf Some more explainations in places, typos fixed, a little reorg, etc. 2004-03-26 23:13:47 +00:00
INSTALL.html regenerated the ReST docs 2005-05-09 23:17:49 +00:00
INSTALL.txt 2.5 --> 2.6 changes 2005-04-19 22:38:35 +00:00
MigrationGuide.html regenerated the ReST docs 2005-05-09 23:17:49 +00:00
MigrationGuide.txt No longer building the C++ version of the OGL lib 2005-04-20 21:44:36 +00:00
PyManual.html regenerated the ReST docs 2005-05-09 23:17:49 +00:00
PyManual.txt removed stuff about the decorator classes 2004-04-15 18:12:15 +00:00
README.html regenerated the ReST docs 2005-05-09 23:17:49 +00:00
README.txt Namechange changes 2004-03-02 23:49:39 +00:00
wxPackage.html regenerated the ReST docs 2005-05-09 23:17:49 +00:00
wxPackage.txt Other doc updates 2004-03-26 21:27:23 +00:00
wxPython-epydoc.css Docstrings for the sizers 2004-06-04 05:18:49 +00:00
wxPythonManual.html regenerated the ReST docs 2005-05-09 23:17:49 +00:00
wxPythonManual.txt Other doc updates 2004-03-26 21:27:23 +00:00

wxPython README
---------------

Welcome to the wonderful world of wxPython!

So where do you go from here?  The best thing to do is to run the demo
and use its source code to help you learn how to use wxPython.  Most
of the classes available are demonstrated there, and you can view the
sources directly in the demo so it is designed to help you learn.  If
you are on Windows or OS X then you can run the demo just by double
clicking it's icon.  If you are on Linux/Unix then change to the
directory containing the demo and type:

    python demo.py

There are also some sample mini applications available for you to run
and to play with as a learning exercise.

The next thing you should do is join the wxPython-users maillist where
you can interact with a community of other users and developers who
are willing to help you learn, answer questions and solve problems.
To join the mail list just go to this web page and follow the
instructions there:

             http://wxpython.org/maillist.php

There is also a good set of class reference documentation available
for wxPython, but currently it is geared for the C++ user.  This may
be a little daunting at first, but with a little practice you'll
easily be able to "mentally translate" from the C++ shown into Python.
(See http://wiki.wxpython.org/index.cgi/C_2b_2bGuideForwxPythoneers
for a little help on this process.) Not all classes documented are
available in Python, but most of the GUI related classes are.


Other Info
----------

Please also see the following files:

   docs/CHANGES.txt        Information about new features, fixes,
                           etc. in each release.

   docs/BUILD.txt          Instructions for building wxPython on
                           various Unix-like platforms, OS X or
                           Windows.

   docs/MigrationGuide.txt Information about some big changes from 2.4
                           to 2.5 that require changes to your
                           applications

   licence/*               Text of the wxWidgets license.



--
Robin Dunn
robin@alldunn.com