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