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