Update 'README.md'

Added args, could use better explanation/man file and link to reflex map format file
This commit is contained in:
suhrke 2017-07-03 17:12:26 -07:00
parent a5261c1b01
commit 58d24d67b4

View File

@ -1,5 +1,5 @@
# reflex2q3 # 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. Crossplatform application that converts Reflex .map files into working idTech 3 .map files. Supports NetRadiant brush format by default and GtkRadiant format with a command line switch, as well as partial entity conversion for Xonotic entities.
From your command line, build the project by typing From your command line, build the project by typing
```Bash ```Bash
@ -10,7 +10,7 @@ make
and convert the input.map into output.map by typing and convert the input.map into output.map by typing
```Bash ```Bash
reflex2q3 input.map output.map [-gtk] reflex2q3 input.map output.map [-gtk] [-e r2x.pck]
``` ```
@ -20,6 +20,6 @@ reflex2q3 input.map output.map [-gtk]
[Reflex Map Format](http://) [Reflex Map Format](https://git.teknik.io/scuti/reflex2q3/src/master/reflex-mapping.txt)
[Xonotic Map Format](https://github.com/xonotic/xonotic/blob/master/Docs/mapping.txt) [Xonotic Map Format](https://github.com/xonotic/xonotic/blob/master/Docs/mapping.txt)