diff --git a/README b/README index f986228..304388b 100644 --- a/README +++ b/README @@ -20,8 +20,10 @@ $ -tileset -level Example: $ build/sle -tileset assets/tileset.png -level sample.kble -USAGE -===== +SYNOPSIS +======== +usage: sle -tileset path -level path [options] + Two windows should appear. A main window, with the level you are currently editing, and a secondary one, containing the tileset you provided. @@ -30,9 +32,8 @@ This software is controlled using a mice. Main window - Editing Area -------------------------- -Use then: -* left click: draw with selected tile -* right click: erase (tile 0) +Left click: draw with selected tile +Right click: erase (tile 0) Secondary window - Tile Picker ------------------------------ @@ -43,9 +44,32 @@ Exit and save Close/kill the main window. The secondary window will close automaticly and your modifications to the level file will be writen to disk. -CONFIGURATION -============= -Edit include/conf.h to configure the software. Read the comments! +FLAGS +====== + +Mendatory flags +--------------- +All these options take a path to a file as argument. +-tileset Tileset image +-level KBLE file + +Optionnal flags +--------------- +All these options take integers as argument. + +-tile-width +-tile-height +-editor-width +-editor-height +-editor-target-fps +-editor-off-x +-editor-off-y +-picker-target-fps +-picker-padding + +DEFAULT CONFIGURATION +===================== +Edit include/conf.h to change default configuration. Read the comments! Don't forget to recompile after you made your modifications. LICENSE