Jason McKesson avatar Jason McKesson committed b7dc664

Updated the home page to have actual docs.

Comments (0)

Files changed (1)

-= Welcome =
+= OpenGL Loader Generator =
 
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
+This loader generation system is used to create OpenGL headers and loading code for your specific needs. Rather than getting every extension and core enumerator/function all in one massive header, you get only what you actually want and ask for.
 
-== Wiki features ==
+This is still very experimental; little testing has been done on it yet. [[https://bitbucket.org/alfonse/glloadgen/downloads|Download it here;]] you will need to have the Lua runtime installed on your machine to use the code generation scripts. It's pretty tiny, so it shouldn't be a problem. Windows users can install [[http://code.google.com/p/luaforwindows/|Lua For Windows]], or just [[http://luabinaries.sourceforge.net/|the Lua binaries packages]]. The code should be compatible with Lua 5.1 and 5.2, but it has only been tested on 5.1.
 
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a mercurial repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
+To use the code generator, with Lua in your path (assuming that {{{lua}}} is the name of your Lua executable), type this:
 
 {{{
-$ hg clone https://bitbucket.org/alfonse/glloadgen/wiki
+lua LoadGen.lua -style=pointer_c -spec=gl -version=3.3 -profile=core core_3_3
 }}}
 
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
+This tells the system to generate a header/source pair for OpenGL ({{{-spec=gl}}}, as opposed to WGL or GLX), for version 3.3, the core profile. It will generate it in the {{{pointer_c}}} style, which specifies the way it provides the {{{#defines}}} and function pointers. See below for details.
 
-== Syntax highlighting ==
+The option {{{core_3_3}}} is the basic component of the filename that will be used for the generation. Since it is generating OpenGL loaders (again, as opposed to WGL or GLX), it will generate files named {{{gl_core_3_3.*}}}, where * is the extension used by the particular style. {{{pointer_c}}}, as the name suggests, generates function pointer-style loaders with C linkage and source code. Such code is usable from C and C++.
 
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
+The above command line will generate {{{gl_core_3_3.h}}} and {{{gl_core_3_3.c}}} files. Simply include them in your project; there is no library to build, no unresolved extenals to filter through. They just work.
 
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-    formatter = lambda t: "funky"+t
-    return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+Well, that's the plan ;)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.