docs/index.htm

   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
   4 <html xmlns="http://www.w3.org/1999/xhtml">
   5
   6   <!--
   7     Name:        index.htm
   8     Purpose:     gateway to wxWidgets documentation
   9     Author:      wxWidgets team
  10     RCS-ID:      $Id$
  11     Licence:     wxWindows license
  12   -->
  13
  14   <head>
  15     <title>wxWidgets Documentation</title>
  16     <style type="text/css">
  17       <!--
  18           li { line-height: 150%; }
  19       -->
  20     </style>
  21   </head>
  22
  23   <body>
  24     <a name="top"/>
  25
  26     <h1 style="font-size: 145%">
  27       Welcome to <em style="font-size: 150%">wxWidgets</em>: a portable C++ and Python GUI toolkit
  28     </h1>
  29
  30     <center>
  31     <img src="doxygen/images/main_wxlogo.png" alt="wxWidgets logo" />
  32     </center>
  33     <br/>
  34
  35     <p>This page lets you access various resources for
  36        <a href="http://www.wxwidgets.org">wxWidgets</a> development. Enjoy!</p>
  37
  38     <br/>
  39     <center>
  40       <font size="-1">[<a href="#install">Install</a>]&nbsp;[<a href="#doc">Documentation</a>]
  41         [<a href="#technotes">Technical Notes</a>]&nbsp;[<a href="#demos">Demos</a>]</font>
  42     </center>
  43     <br/>
  44
  45
  46
  47     <!--
  48         INSTALLATION AND RELEASE NOTES
  49     -->
  50
  51     <table width="100%" border="0" cellpadding="3" cellspacing="0">
  52     <tr>
  53       <td bgcolor="#004080">
  54         <font size="+1" color="#FFFFFF">
  55           <b><a name="install">Installation and release notes</a></b>
  56         </font>
  57       </td>
  58     </tr>
  59     </table>
  60
  61     <p>Unless you installed a binary version of wxWidgets (e.g. under Linux using your distro's
  62        package manager), you will probably have to <strong>compile</strong> the wxWidgets library
  63        before you can start use it.</p>
  64     <p>Please read the platform-specific <tt>readme.txt</tt> and <tt>install.txt</tt>
  65        for how to do this:</p>
  66
  67     <ul>
  68     <li>ReadMe:
  69       <a href="readme.txt"><b>General ReadMe</b></a>, <a href="msw/readme.txt">wxMSW</a> (<a href="msw/winxp.txt">wxMSW for WinXP</a>), <a href="gtk/readme.txt">wxGTK</a>, <a href="mac/readme.txt">wxMac</a>, <a href="cocoa/readme.txt">wxCocoa</a>, <a href="mgl/readme.txt">wxMGL</a>, <a href="motif/readme.txt">wxMotif</a>, <a href="x11/readme.txt">wxX11</a>, <a href="univ/readme.txt">Univ</a>
  70     </li>
  71     <li>Installation:
  72         <a href="msw/install.txt">wxMSW</a>, <a href="gtk/install.txt">wxGTK</a>, <a href="motif/install.txt">wxMotif</a>, <a href="x11/install.txt">wxX11</a>, <a href="mac/install.txt">wxMac</a>, <a href="cocoa/install.txt">wxCocoa</a>, <a href="mgl/install.txt">wxMGL</a>, <a href="os2/install.txt">wxOS2</a>
  73     </li>
  74     <li>
  75         <a href="changes.txt"><b>General change log</b></a>
  76     </li>
  77     <li>Licence:
  78         <a href="preamble.txt">Preamble</a>, <a href="licence.txt">Licence</a>, <a href="licendoc.txt">Documentation Licence</a>, <a href="lgpl.txt">L-GPL</a>, <a href="gpl.txt">GPL</a>
  79     </li>
  80
  81     <!-- FIXME: FAQs are very out-of-date; should be moved in the wx docs or
  82                 to the website or to the wiki...
  83
  84
  85     <li><a href=
  86     "faq.htm"><b>FAQ</b></a>:</font>
  87     <ul>
  88     <li><a href=
  89     "faqgen.htm">General questions</a></font></li>
  90     <li><a href=
  91     "faqcmn.htm">Questions common to all platforms</a></font></li>
  92     <li><a href=
  93     "faqmsw.htm">wxWidgets for Windows</a></font></li>
  94     <li><a href=
  95     "faqgtk.htm">wxWidgets for GTK+</a></font></li>
  96     <li><a href=
  97     "faqmot.htm">wxWidgets for Motif</a></font></li>
  98     <li><a href=
  99     "faqx11.htm">wxWidgets for X11</a></font></li>
 100     <li><a href=
 101     "faqmac.htm">wxWidgets for Mac</a></font></li>
 102     </ul>
 103     </li>
 104     -->
 105
 106     <!-- FIXME: todo lists are in the wiki now....  -->
 107     <li>ToDo: <a href="todo.txt"><b>General ToDo</b></a>, <a href="gtk/todo.txt">wxGTK</a>, <a href="motif/todo.txt">wxMotif</a>, <a href="mac/todo.txt">wxMac</a></li>
 108     </ul>
 109
 110
 111
 112     <!--
 113         DOCUMENTATION
 114     -->
 115
 116     <table width="100%" border="0" cellpadding="3" cellspacing="0">
 117     <tr>
 118       <td bgcolor="#004080">
 119         <font size="+1" color="#FFFFFF"><b><a name="doc">Documentation</a></b></font>
 120       </td>
 121     </tr>
 122     </table>
 123
 124     <p>The wxWidgets manual is available in various formats; the availability of the following
 125        formats depends on what you've downloaded from the
 126        <a href="http://www.wxwidgets.org">wxWidgets Web site</a>:</p>
 127
 128     <ul>
 129       <li><a href="doxygen/out/html/index.html">HTML</a></li>
 130       <li><a href="doxygen/out/wx.chm">MS HTML Help (CHM)</a></li>
 131       <li><a href="doxygen/out/wx.htb">wxHTML Help (HTB)</a></li>
 132       <li><a href="doxygen/out/rtf/refman.rtf">Rich Text Format (RTF)</a></li>
 133       <li><a href="doxygen/out/wx.pdf">Portable Document Format (PDF)</a></li>
 134     </ul>
 135
 136     <p>To use the manual in the <b>wxHTML Help</b> format (extension <tt>htb</tt>), you
 137        can use the <b>HelpView</b> application, compiling it from the <tt>utils/helpview</tt>
 138        folder in the wxWidgets distribution.</p>
 139
 140      <p>Also note that beyond the wxWidgets manual there are various other <strong>resources</strong> which can
 141         help to learn wxWidgets programming:</p>
 142
 143       <ul>
 144         <li><a href="http://www.wxwidgets.org">The wxWidgets website</a>: contains FAQs, tutorials,
 145             info about the mailing lists, and in general everything related to the wxWidgets world
 146             is linked here.</li>
 147         <li><a href="http://wxforum.shadonet.com/">The wxWidgets forum</a>: provides a discussion board
 148             about various wxWidgets topics (contains also <em>localized</em> forums)</li>
 149         <li><a href="http://www.wxwidgets.org/wiki">The wxWidgets wiki</a>: a user-editable website
 150             with lots of tutorials, links to external tools, resources, etc</li>
 151     </ul>
 152
 153
 154     <!--
 155         TECHNICAL NOTES
 156     -->
 157
 158     <table width="100%" border="0" cellpadding="3" cellspacing="0">
 159     <tr>
 160       <td bgcolor="#004080">
 161         <font size="+1" color="#FFFFFF"><b><a name="technotes">Technical notes</a></b></font>
 162       </td>
 163     </tr>
 164     </table>
 165
 166     <p>Technical notes contains informations useful only to wxWidgets developers for
 167        the maintainance of the project:</p>
 168
 169     <ul>
 170       <li><a href="tech/index.txt">Index of technical notes</a></li>
 171       <li><a href="tech/">Technical notes</a></li>
 172
 173       <!-- FIXME: should be either removed or integrated with doxy docs
 174       <li><a href="platform.htm">Platforms supported</a></font></li>
 175       <li><a href="i18n.htm">Languages supported by wxWidgets</a></font></li>
 176       -->
 177     </ul>
 178
 179
 180
 181     <!--
 182         DEMOS
 183     -->
 184
 185     <table width="100%" border="0" cellpadding="3" cellspacing="0">
 186     <tr>
 187     <td bgcolor="#004080">
 188       <font size="+1" color="#FFFFFF"><b><a name="demos">Demos</a></b></font>
 189     </td>
 190     </tr>
 191     </table>
 192
 193     <p>The following are fully-fledged applications which demonstrate some features of wxWidgets
 194        (for a list of the 70+ samples please look at the manual):</p>
 195     <ul>
 196       <li><a href="../demos/bombs">bombs</a>: minesweeper-like game.</li>
 197       <li><a href="../demos/forty">forty</a>: a great little card game by Chris Breeze.</li>
 198       <li><a href="../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.</li>
 199       <li><a href="../demos/life">life</a>: the game of Life by J. H. Conway,
 200           implemented in wxWidgets by Guillermo Rodriguez Garcia.</li>
 201       <li><a href="../demos/poem">poem</a>: a little poetry display program.</li>
 202     </ul>
 203
 204   </body>
 205
 206   <!-- kate: space-indent on; indent-width 2; indent-mode xml; -->
 207
 208 </html>