Added readme file.

This commit is contained in:
the_fiddler 2009-07-31 15:37:27 +00:00
parent c8f7ae4c12
commit adf515007a
2 changed files with 27 additions and 1 deletions

View file

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="3.5">
<PropertyGroup>
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
@ -53,6 +53,7 @@
<Compile Include="ESCLParser.cs" />
</ItemGroup>
<ItemGroup>
<Content Include="Readme.txt" />
<Content Include="XML schema notes.txt" />
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

View file

@ -0,0 +1,25 @@
[Introduction]
This is a simple tool to convert C headers to XML files. It works using simple pattern matching - it does not actually parse the header files. For this reason, it will work with only a few, specific header files: ES and CL at this point.
[Usage]
CHeaderToXML.exe -p:{PREFIX} -v:{VERSION} {INPUT}
{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.
{INPUT} is a space-separated list of input files (headers).
Despite what the help says, all three parameters are necessary at the moment.
[Known issues]
None at the moment.
[Support]
If you encounter a bug, please file an issue report at http://www.opentk.com/issues
We will only accept bug reports for supported header files. This is not a generic tool and will fail to parse unsupported files.