From d307e7de9df0d413e0bbc266c16c85a299de8296 Mon Sep 17 00:00:00 2001
From: the_fiddler <the_fiddler@ebc5dd9b-fb1d-0410-b6f8-d24c324e9604>
Date: Fri, 31 Jul 2009 15:37:27 +0000
Subject: [PATCH] Added readme file.

---
 .../CHeaderToXML/CHeaderToXML.csproj          |  3 ++-
 Source/Converter/CHeaderToXML/Readme.txt      | 25 +++++++++++++++++++
 2 files changed, 27 insertions(+), 1 deletion(-)
 create mode 100644 Source/Converter/CHeaderToXML/Readme.txt

diff --git a/Source/Converter/CHeaderToXML/CHeaderToXML.csproj b/Source/Converter/CHeaderToXML/CHeaderToXML.csproj
index 57629920..3d8939e9 100644
--- a/Source/Converter/CHeaderToXML/CHeaderToXML.csproj
+++ b/Source/Converter/CHeaderToXML/CHeaderToXML.csproj
@@ -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" />
diff --git a/Source/Converter/CHeaderToXML/Readme.txt b/Source/Converter/CHeaderToXML/Readme.txt
new file mode 100644
index 00000000..291d1771
--- /dev/null
+++ b/Source/Converter/CHeaderToXML/Readme.txt
@@ -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.
\ No newline at end of file