Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dwmkerr committed Mar 10, 2014
1 parent ecbfe79 commit 8a7a92c
Showing 1 changed file with 52 additions and 5 deletions.
57 changes: 52 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,58 @@ Unlock the power of OpenGL in any .NET application. SharpGL wraps all modern Ope
Contents
--------

1. [Gettings Started](#Getting-Started)
2. [Building the Code]()
3. [Sample Applications]()
4. [Documentation]()
5. [Credits, Sponsorship & Thanks]()
1. [Gettings Started](#getting-started)
2. [Building the Code](#building-the-code)
3. [Sample Applications](#sample-applications)
4. [Documentation](#documentation)
5. [Credits, Sponsorship & Thanks](#credits-sponsorship-and-thanks)

Getting Started
---------------

Installing SharpGL is easy, just use Nuget:

````
PM> Install-Package SharpGLCore
````

The Core is simply the full set of OpenGL functions and extensions wrapped and available to use.

````
PM> Install-Package SharpGLforWinForms
````

SharpGL for WinForms includes the Core as well as OpenGL controls to drop into your WinForms app.

````
PM> Install-Package SharpGLforWPF
````

SharpGL for WPF includes the Core as well as OpenGL controls to drop into your WPF app.

You can also get the binaries by going to the [Releases](https://github.com/dwmkerr/sharpgl/releases) page of this site.

Building the Code
-----------------

To build the code, clone the repo and open the SharpGL, Samples or Tools solution. All solutions are ready to go and require no additional components.

Sample Applications
-------------------

There are a large number of sample applications that show how to use SharpGL. Check out the 'Samples' solution to see the samples that are available - they'll be documented soon.

Documentation
-------------

It's finally a work in progress.

Credits, Sponsorship & Thanks
-----------------------------

SharpGL is written and maintained by me. It's proudly sponsored by:

*** NDepend ***

Some notable contributions have come from:

0 comments on commit 8a7a92c

Please sign in to comment.