diff --git a/README.md b/README.md index 4a657ba..c0ead3e 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,7 @@ task('setup_env', ['always' => true], It's possible to specify miscellaneous build properties to setup a proper build environment conditions. There's a set of routines which provides taskman for properties manipulation. -### Setting a property +#### Setting a property Use **set** built-in function: @@ -168,7 +168,7 @@ task('setup_env', ['always' => true], }); ``` -### Setting a property only if it's not already set +#### Setting a property only if it's not already set Use **setor** built-in function. Property will be set only if it's not set some where before. It's a convenient pattern to have a default set of properties which can be overriden by the environment properties included from an external script. @@ -182,7 +182,7 @@ task('setup_env', ['always' => true], }); ``` -### Getting a property +#### Getting a property Use **get** built-in function: @@ -196,7 +196,7 @@ task('build_ios', }); ``` -### Getting a property or some default value +#### Getting a property or some default value Use **getor** built-in function: @@ -208,4 +208,28 @@ task('build_ios', function() { shell("xcode build app " . getor("IOS_APP_ID", "3232232")); }); -``` \ No newline at end of file +``` + +#### Listing all build properties + +To list all defined build properties one should use the **props** task: + +``` +./gamectl props + +***** task 'props' start ***** + +Available props: +--------------------------------- +UNITY_ASSETS_DIR : '/Users/ps/dev/skeletor//unity/Assets/' +--------------------------------- +GAME_COMPANY_NAME : 'Black Hole Light' +***** task 'props' done(0.11/0.11 sec.) ***** +***** All done (0.11 sec.) ***** +``` + +You can filter properties you want to get information about by a partial match as follows: + +``` +./gamectl props FOO +```