From 997247302ede862b728daee52ea1b064f74f0c7c Mon Sep 17 00:00:00 2001 From: Jarl Gullberg Date: Sat, 15 Jul 2017 15:47:16 +0200 Subject: [PATCH] Updated and renamed README file. --- src/Generator.Converter/Generator.Convert.csproj | 3 +-- src/Generator.Converter/README.md | 24 ++++++++++++++++++++++++ src/Generator.Converter/Readme.txt | 24 ------------------------ 3 files changed, 25 insertions(+), 26 deletions(-) create mode 100644 src/Generator.Converter/README.md delete mode 100644 src/Generator.Converter/Readme.txt diff --git a/src/Generator.Converter/Generator.Convert.csproj b/src/Generator.Converter/Generator.Convert.csproj index ad4783e..f0cd3f6 100644 --- a/src/Generator.Converter/Generator.Convert.csproj +++ b/src/Generator.Converter/Generator.Convert.csproj @@ -108,8 +108,7 @@ - - + diff --git a/src/Generator.Converter/README.md b/src/Generator.Converter/README.md new file mode 100644 index 0000000..447ac58 --- /dev/null +++ b/src/Generator.Converter/README.md @@ -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). \ No newline at end of file diff --git a/src/Generator.Converter/Readme.txt b/src/Generator.Converter/Readme.txt deleted file mode 100644 index 8b3ed08..0000000 --- a/src/Generator.Converter/Readme.txt +++ /dev/null @@ -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 \ No newline at end of file -- 2.7.4