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