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