mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-26 06:14:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Formatting.

Browse Source
This commit is contained in:
Camilla Berglund 2012-04-11 11:33:42 +02:00
parent 77633d8d9a
commit 21faa7b84f
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
readme.html
View File

@ -20,7 +20,8 @@
<li><a href="#credits">Acknowledgements</a></li>
</ol>
<a name="intro">
<a name="intro"></a>
<h2>1. Introduction</h2>
<p>Welcome to version 3.0 of the GLFW library. GLFW is a free, open source,
@ -34,19 +35,22 @@ settle.</p>
<p><strong>Note</strong> that the threading and image loading APIs from the 2.x
series have been removed.</p>
<a name="compiling">
<a name="compiling"></a>
<h2>2. Compiling GLFW and the example programs</h2>
<p>To compile GLFW and the accompanying example programs, you will need the
<a href="http://www.cmake.org/">CMake</a> build system.</p>
<a name="installing">
<a name="installing"></a>
<h2>3. Installing GLFW</h2>
<p>A rudimentary installation target is provided for all supported platforms
via the CMake build system.</p>
<a name="using">
<a name="using"></a>
<h2>4. Using GLFW</h2>
<p>There are two aspects to using GLFW:</p>
@ -66,6 +70,7 @@ GLFW API.</p>
A few rules for successfully designing GLFW-based programs are presented
in the following sections.</p>
<h3>4.1 Include the GLFW header file</h3>
<p>In the files of your program where you use OpenGL or GLFW, you should
@ -106,9 +111,9 @@ disable any <code>gl.h</code> that the GLFW header includes and GLEW will work
as expected.</p>
<h3>4.2 Link with the right libraries</h3>
<h4>4.2.1 Windows static library</h4>
<p>If you link with the static version of GLFW, it is also necessary to
@ -219,7 +224,6 @@ by compile.sh at compile time.</p>
<code>-lGLU</code> to your link flags.</p>
<h4>4.2.5 Mac OS X static library</h4>
<p>When compiling and linking a program under Mac OS X that uses GLFW, you
@ -256,9 +260,11 @@ that even though your machine may have Unix-style OpenGL libraries, they are for
use with the X Window System, and will <em>not</em> work with the Mac OS X native
version of GLFW.</p>
<a name="changelog">
<a name="changelog"></a>
<h2>5. Version history</h2>
<h3>v3.0</h3>
<ul>
<li>Added <code>GLFWwindow</code> window handle type and updated window-related functions and callbacks to take a window handle</li>
@ -768,7 +774,7 @@ version of GLFW.</p>
</ul>
<a name="structure">
<a name="structure"></a>
<h2>6. Directory structure of the GLFW distribution</h2>
<p>Here is an overview of the directory structure of the GLFW distribution:
@ -791,7 +797,7 @@ version of GLFW.</p>
</table>
<a name="contact">
<a name="contact"></a>
<h2>7. Contacting the project</h2>
<p>The official website for GLFW is <a href="http://www.glfw.org/">glfw.org</a>.
@ -815,7 +821,7 @@ GLFW or porting it to your favorite platform, we have a
or you could join us on <code>#glfw</code>.
<a name="credits">
<a name="credits"></a>
<h2>8. Acknowledgements</h2>
<p>GLFW exists because people around the world donated their time and lent