Opentk/Source/Converter/Readme.txt

[Introduction]

This is a simple tool to convert Khronos XML to OpenTK XML files. 

[Examples]

To download and convert the XML API registry from Khronos:
Convert.exe -p:gl -o:../../../Source/Bind/Specifications/GL2/signatures.xml https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/gl.xml

The line above will download the latest .xml files from the public Khronos repository and update signatures.xml for the binding generator.

[Usage]

Convert.exe -p:{PREFIX} -v:{VERSION} -t:{TYPE} -o:{OUT} {INPUT1} ... {INPUTn}
    {PREFIX} is a simple string that defines the a common prefix for functions and constants in this header. This prefix will be removed from the generated XML file.
    {VERSION} is a string that defines that version that will be used for functions in the generated XML file. Specific input files may override this setting.
	{OUT} is the output filename (optional). If no output file is specified, output will be directed to the console.
    {INPUT1..n} is a space-separated list of input files.
    
Despite what the help says, prefix and version parameters are necessary at the moment.

[Support]

If you encounter a bug, please file an issue report at http://github.com/opentk/opentk/issues
Fixed mime-type and eol-style on Readme.txt. 2009-09-06 09:38:04 +00:00			`[Introduction]`

[Bind] Remove all C header code from Convert Cleaning up old C header code from convert, we'll just deal with Khronos XML files now. If there's a need for parsing C headers we should do that as a separate tool that either parses and generates the OpenTK XML specs directly generates Khronos XML specs that can then be parsed by Convert. 2015-06-08 14:38:08 +00:00			`This is a simple tool to convert Khronos XML to OpenTK XML files.`
Fixed mime-type and eol-style on Readme.txt. 2009-09-06 09:38:04 +00:00
Added usage example for new xml specs 2013-11-07 16:18:12 +00:00			`[Examples]`
Added usage example. 2013-10-22 09:40:41 +00:00
Remove spec support from converter Khronos stopped supporting .spec files in 2013. They're now over a year old without support. As such it's not worth us continuing to support them either. 2015-03-01 14:25:30 +00:00			`To download and convert the XML API registry from Khronos:`
[Bind] Remove all C header code from Convert Cleaning up old C header code from convert, we'll just deal with Khronos XML files now. If there's a need for parsing C headers we should do that as a separate tool that either parses and generates the OpenTK XML specs directly generates Khronos XML specs that can then be parsed by Convert. 2015-06-08 14:38:08 +00:00			`Convert.exe -p:gl -o:../../../Source/Bind/Specifications/GL2/signatures.xml https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/gl.xml`
Added usage example for new xml specs 2013-11-07 16:18:12 +00:00
Remove spec support from converter Khronos stopped supporting .spec files in 2013. They're now over a year old without support. As such it's not worth us continuing to support them either. 2015-03-01 14:25:30 +00:00			`The line above will download the latest .xml files from the public Khronos repository and update signatures.xml for the binding generator.`
Added usage example. 2013-10-22 09:40:41 +00:00
Fixed mime-type and eol-style on Readme.txt. 2009-09-06 09:38:04 +00:00			`[Usage]`

Updated Generator.Convert documentation to match what the tool actually does. 2011-07-26 11:54:09 +00:00			`Convert.exe -p:{PREFIX} -v:{VERSION} -t:{TYPE} -o:{OUT} {INPUT1} ... {INPUTn}`
Fixed mime-type and eol-style on Readme.txt. 2009-09-06 09:38:04 +00:00			`{PREFIX} is a simple string that defines the a common prefix for functions and constants in this header. This prefix will be removed from the generated XML file.`
			`{VERSION} is a string that defines that version that will be used for functions in the generated XML file. Specific input files may override this setting.`
Updated Generator.Convert documentation to match what the tool actually does. 2011-07-26 11:54:09 +00:00			`{OUT} is the output filename (optional). If no output file is specified, output will be directed to the console.`
[Bind] Remove all C header code from Convert Cleaning up old C header code from convert, we'll just deal with Khronos XML files now. If there's a need for parsing C headers we should do that as a separate tool that either parses and generates the OpenTK XML specs directly generates Khronos XML specs that can then be parsed by Convert. 2015-06-08 14:38:08 +00:00			`{INPUT1..n} is a space-separated list of input files.`
Fixed mime-type and eol-style on Readme.txt. 2009-09-06 09:38:04 +00:00
[Bind] Remove all C header code from Convert Cleaning up old C header code from convert, we'll just deal with Khronos XML files now. If there's a need for parsing C headers we should do that as a separate tool that either parses and generates the OpenTK XML specs directly generates Khronos XML specs that can then be parsed by Convert. 2015-06-08 14:38:08 +00:00			`Despite what the help says, prefix and version parameters are necessary at the moment.`
Fixed mime-type and eol-style on Readme.txt. 2009-09-06 09:38:04 +00:00
			`[Support]`

[Bind] Remove all C header code from Convert Cleaning up old C header code from convert, we'll just deal with Khronos XML files now. If there's a need for parsing C headers we should do that as a separate tool that either parses and generates the OpenTK XML specs directly generates Khronos XML specs that can then be parsed by Convert. 2015-06-08 14:38:08 +00:00			`If you encounter a bug, please file an issue report at http://github.com/opentk/opentk/issues`