Updated and renamed README file.

This commit is contained in:
Jarl Gullberg 2017-07-15 15:47:16 +02:00
parent 36357873a7
commit 997247302e
No known key found for this signature in database
GPG key ID: 750FF6F6BDA72D23
3 changed files with 25 additions and 26 deletions

View file

@ -108,8 +108,7 @@
<None Include="paket.references" />
<None Include="XML schema notes.txt">
</None>
<None Include="Readme.txt">
</None>
<Content Include="README.md" />
<Compile Include="GLXmlParser.cs" />
</ItemGroup>
<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />

View file

@ -0,0 +1,24 @@
### Introduction
This is a simple tool to convert Khronos XML to OpenTK XML files.
### Usage
```
Converting local files:
Convert.exe --input-files gl.xml --output-file signatures.xml --prefix gl
Converting latest remote specification:
Convert.exe --input-files https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/gl.xml --output-file signatures.xml --prefix gl
-p, --prefix Required. (Default: gl) The prefix to remove from parsed functions and constants.
-o, --output-file The path to the output file. Defaults to stdout if no path is provided.
-i, --input-files Required. A list of the Khronos XML files to parse into OpenTK XML. Remote resources in the form of URLs are supported.
--help Display this help screen.
--version Display version information.
```
### Support
If you encounter a bug, please file an issue report at the OpenTK [issue tracker](http://github.com/opentk/opentk/issues).

View file

@ -1,24 +0,0 @@
[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