[wxWidgets.git] / docs / index.htm

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<!--
  Name:        index.htm
  Purpose:     Gateway to wxWidgets Documentation and Resources
  Author:      wxWidgets team
  Licence:     wxWindows licence
-->

<head>
  <title>wxWidgets Documentation</title>
  <style type="text/css">
  <!--
    body { font-family: sans-serif; }
	h1 { font-size: 140%; }
    li { line-height: 150%; }
  -->
  </style>
</head>

<body>

  <a name="top"/>

  <p><center>
    <img src="doxygen/images/main_wxlogo.png" alt="wxWidgets: Cross-Platform GUI Toolkit" />
  </center></p>

  <!-- INSTALLATION AND RELEASE NOTES -->

  <h1>Installation and Release Notes</h1>

  <p>Unless you installed a binary version of wxWidgets (e.g. under Linux
     using your distro's package manager), you will probably have to
     <strong>compile</strong> the wxWidgets library before you can start use
     it.</p>
  <p>Please read the platform-specific <tt>readme.txt</tt> and
     <tt>install.txt</tt> for how to do this:</p>

  <ul>
    <li>Readme:
      <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="motif/readme.txt">wxMotif</a>,
      <a href="x11/readme.txt">wxX11</a>,
      <a href="univ/readme.txt">Univ</a>
    </li>
    <li>Installation:
      <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="os2/install.txt">wxOS2</a>
    </li>
    <li><a href="changes.txt"><b>General change log</b></a></li>
    <li>Licence:
      <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>
    </li>
  </ul>

  <!-- FIXME: FAQs are very out-of-date; should be moved in the wx docs or
              to the website or to the wiki...

    <li><a href="faq.htm"><b>FAQ</b></a>:</font>
    <ul>
    <li><a href="faqgen.htm">General questions</a></font></li>
    <li><a href="faqcmn.htm">Questions common to all platforms</a></font></li>
    <li><a href="faqmsw.htm">wxWidgets for Windows</a></font></li>
    <li><a href="faqgtk.htm">wxWidgets for GTK+</a></font></li>
    <li><a href="faqmot.htm">wxWidgets for Motif</a></font></li>
    <li><a href="faqx11.htm">wxWidgets for X11</a></font></li>
    <li><a href="faqmac.htm">wxWidgets for Mac</a></font></li>
    </ul>
    </li>

  -->

  <!-- DOCUMENTATION -->

  <h1>Documentation</h1>

  <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 website</a>:</p>

  <ul>
    <li><a href="doxygen/out/html/index.html">HTML</a></li>
    <li><a href="doxygen/out/wx.chm">MS HTML Help (CHM)</a></li>
    <li><a href="doxygen/out/wx.htb">wxHTML Help (HTB)</a></li>
    <li><a href="doxygen/out/rtf/refman.rtf">Rich Text Format (RTF)</a></li>
    <li><a href="doxygen/out/wx.pdf">Portable Document Format (PDF)</a></li>
  </ul>

  <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>

  <p>Also note that beyond the wxWidgets manual there are various other
     <strong>resources</strong> which can help to learn wxWidgets
     programming:</p>

  <ul>
    <li><a href="http://www.wxwidgets.org">The wxWidgets website</a>: Contains
        FAQs, tutorials, info about the mailing lists, and in general
        everything related to the wxWidgets world is linked here.</li>
    <li><a href="http://wxforum.shadonet.com/">The wxWidgets forum</a>:
        Provides a discussion board about various wxWidgets topics (contains
        also <em>localized</em> forums).</li>
    <li><a href="http://wiki.wxwidgets.org/">The wxWiki</a>: A user-editable
        website with lots of tutorials, links to external tools, resources,
        etc.</li>
  </ul>

  <!-- TECHNICAL NOTES -->

  <h1>Technical Notes</h1>

  <p>Technical notes contains informations useful only to wxWidgets developers
     for the maintainance of the project:</p>

  <ul>
    <li><a href="tech/index.txt">Index of Technical Notes</a></li>
    <li><a href="tech/">Technical Notes</a></li>
  </ul>

  <p>Todo List for wxWidgets:</p>

  <ul>
    <li><a href="http://wiki.wxwidgets.org/Development:_Todo_List">wxWiki Todo List</a></li>
    <li><a href="doxygen/out/html/todo.html">Documentation Todo List</a></li>
  </ul>

  <!-- DEMOS -->

  <h1>Demos</h1>

  <p>The following are fully-fledged applications which demonstrate some
     features of wxWidgets (for a list of the 70+ samples please look at the
     manual):</p>

  <ul>
    <li><a href="../demos/bombs">bombs</a>: minesweeper-like game.</li>
    <li><a href="../demos/forty">forty</a>: a great little card game by Chris Breeze.</li>
    <li><a href="../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.</li>
    <li><a href="../demos/life">life</a>: the game of Life by J. H. Conway,
        implemented in wxWidgets by Guillermo Rodriguez Garcia.</li>
    <li><a href="../demos/poem">poem</a>: a little poetry display program.</li>
  </ul>

</body>

<!-- kate: space-indent on; indent-width 2; indent-mode xml; -->

</html>
Commit	Line	Data
fce0e8f7 FM	1	<?xml version="1.0" encoding="iso-8859-1"?>
fce0e8f7 FM	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
fce0e8f7	3	<html xmlns="http://www.w3.org/1999/xhtml">
7921cf2b	4
d5693ba9 BP	5	<!--
	6	Name: index.htm
	7	Purpose: Gateway to wxWidgets Documentation and Resources
	8	Author: wxWidgets team
526954c5	9	Licence: wxWindows licence
d5693ba9 BP	10	-->
	11
	12	<head>
	13	<title>wxWidgets Documentation</title>
	14	<style type="text/css">
fce0e8f7	15	<!--
d5693ba9 BP	16	body { font-family: sans-serif; }
	17	h1 { font-size: 140%; }
	18	li { line-height: 150%; }
fce0e8f7	19	-->
d5693ba9 BP	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>,
d5693ba9 BP	49	<a href="motif/readme.txt">wxMotif</a>,
	50	<a href="x11/readme.txt">wxX11</a>,
	51	<a href="univ/readme.txt">Univ</a>
fce0e8f7 FM	52	</li>
fce0e8f7 FM	53	<li>Installation:
d5693ba9 BP	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>,
d5693ba9	60	<a href="os2/install.txt">wxOS2</a>
fce0e8f7	61	</li>
d5693ba9	62	<li><a href="changes.txt"><b>General change log</b></a></li>
fce0e8f7	63	<li>Licence:
d5693ba9 BP	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>
fce0e8f7	69	</li>
d5693ba9	70	</ul>
fce0e8f7	71
d5693ba9 BP	72	<!-- FIXME: FAQs are very out-of-date; should be moved in the wx docs or
d5693ba9 BP	73	to the website or to the wiki...
fce0e8f7	74
d5693ba9	75	<li><a href="faq.htm"><b>FAQ</b></a>:</font>
fce0e8f7	76	<ul>
d5693ba9 BP	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>
fce0e8f7 FM	84	</ul>
fce0e8f7 FM	85	</li>
fce0e8f7	86
d5693ba9	87	-->
fce0e8f7	88
d5693ba9	89	<!-- DOCUMENTATION -->
fce0e8f7	90
d5693ba9	91	<h1>Documentation</h1>
fce0e8f7	92
d5693ba9 BP	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>
fce0e8f7	96
d5693ba9 BP	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>
fce0e8f7	104
d5693ba9 BP	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>
fce0e8f7	109
d5693ba9 BP	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>
fce0e8f7	113
d5693ba9 BP	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>
fce0e8f7	125
d5693ba9	126	<!-- TECHNICAL NOTES -->
fce0e8f7	127
d5693ba9	128	<h1>Technical Notes</h1>
fce0e8f7	129
d5693ba9 BP	130	<p>Technical notes contains informations useful only to wxWidgets developers
d5693ba9 BP	131	for the maintainance of the project:</p>
fce0e8f7	132
d5693ba9 BP	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>
fce0e8f7	137
d5693ba9	138	<p>Todo List for wxWidgets:</p>
fce0e8f7	139
d5693ba9 BP	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>
fce0e8f7	161
d5693ba9	162	</body>
fce0e8f7	163
d5693ba9	164	<!-- kate: space-indent on; indent-width 2; indent-mode xml; -->
fce0e8f7 FM	165
fce0e8f7 FM	166	</html>