README.md in u3d-0.9 vs README.md in u3d-0.9.1

- old
+ new

@@ -4,29 +4,41 @@ ## What can it do? U3d provides help for running and installing unity from CLI. Available commands are: -* `u3d available`: List versions available to download +* `u3d available`: List download-ready versions of Unity3d -* `u3d install`: Download (and install) Unity +![u3d available](https://github.com/DragonBox/u3d/raw/master/docs/assets/u3d_available.png) -* `u3d list`: List installed versions +* `u3d install`: Download (and install) Unity3D packages -* `u3d local_install`: Install already downloaded packages +![u3d install](https://github.com/DragonBox/u3d/raw/master/docs/assets/u3d_install.png) -* `u3d run`: Run Unity +* `u3d list`: List installed versions of Unity3d +![u3d list](https://github.com/DragonBox/u3d/raw/master/docs/assets/u3d_list.png) + +* `u3d local_install`: Install downloaded version of Unity3d + +* `u3d run`: Run Unity, and parses its output through u3d's log prettifier + +![u3d run](https://github.com/DragonBox/u3d/raw/master/docs/assets/u3d_run.png) + +* `u3d prettify`: Prettify a saved logfile + + (see above :)) + ## Installation - The gem isn't yet on a public repository, so do ```shell -./local_gem_install.sh +gem install u3d ``` + ## Security -When you install Unity with this tool, you will have to grant it higher privileges so it can perfrom the installation. It means that under MacOS and Linux, you will be asked for your sudo password. +When you install Unity with this tool, you will have to grant it higher privileges so it can perform the installation. It means that under MacOS and Linux, you will be asked for your `sudo` password. On Windows, you must launch a administrative command interface to be able to run `local_install` and `install` (only if you install for the latter). ## Examples @@ -45,13 +57,19 @@ * Download and install version 5.6.0f3 of Unity with its documentation and the WebPlayer package: ```shell u3d install 5.6.0f3 -p Unity,Documentation,WebPlayer ``` -* Run a CLI on the current project given the configured unity version: +* Run a CLI on the current project given the project's configured unity version, displaying prettified logs, while keeping the original logs under `editor.log`: ```shell u3d run -- -batchmode -quit -logFile `pwd`/editor.log -executeMethod "WWTK.SimpleBuild.PerformAndroidBuild" +``` + +* Open the proper Unity3d for the current project, displaying the raw editor logs in the command line: + +```shell +u3d run -r ``` You can get further information on how to use U3d by running `u3d --help` (or `u3d -h`). ## SSL Error