From 457595f2ff895a3a941fc8c2e85522019cf4d237 Mon Sep 17 00:00:00 2001 From: suhrke Date: Mon, 3 Jul 2017 16:47:43 -0700 Subject: [PATCH] Update 'README.md' Intend to add reflex map format description to repo, link later --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 31f2ef3..072ebc1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,25 @@ -# ReflexToQ3 -Converter to convert reflex maps into quake-style .map format. +# reflex2q3 +Crossplatform application that converts Reflex .map files into working idTech 3 .map files. Supports NetRadiant brush format by default and GtkRadiant format through the optional argument -gtk. Current development is focusing on complete conversion to Xonotic .map files. -Usage run from commandline: ReflexToQ3.exe [input].map [output].map +From your command line, build the project by typing +```Bash +make +``` + + +and convert the input.map into output.map by typing + +```Bash +reflex2q3 input.map output.map [-gtk] + +``` + + + + + + + +[Reflex Map Format](http://) + +[Xonotic Map Format](https://github.com/xonotic/xonotic/blob/master/Docs/mapping.txt)