README.md in u3d-1.0.18 vs README.md in u3d-1.0.19
- old
+ new
@@ -3,11 +3,11 @@
[](https://github.com/DragonBox/u3d/blob/master/LICENSE)
[](https://rubygems.org/gems/u3d)
[](https://circleci.com/gh/DragonBox/u3d)
[](https://coveralls.io/github/DragonBox/u3d?branch=master)
-U3d is a set of tools to interact with Unity3D from command line. It is available on Linux, Macintosh and Windows.
+U3d is a set of tools to interact with Unity from command line. It is available on Linux, Macintosh and Windows.
---
## What can it do?
@@ -15,53 +15,58 @@
U3d knows about your Unity project and behaves differently if invoked from within a Unity project directory. For example, it can run or download the version required by your project without you having to specify it.
Available commands are:
-* `u3d available`: List download-ready versions of Unity3d
+* `u3d available`: List download-ready versions of Unity
-* `u3d install`: Download and/or install Unity3D packages
+* `u3d install`: Download (and/or) install Unity editor packages
-* `u3d uninstall`: Uninstall Unity3D versions
+* `u3d uninstall`: Uninstall Unity versions
-* `u3d list`: List installed versions of Unity3d
+* `u3d list`: List installed versions of Unity
-* `u3d run`: Run Unity, and parses its output through u3d's log prettifier.
+* `u3d run`: Run Unity, and parses its output through u3d's log prettifier
Here we start with the proper version of Unity:
Here we pass some arguments:
+
-The prettifyer is on by default but can be turned off to get Unity3d's raw output.
+The prettifyer is on by default but can be turned off to get Unity's raw output.
* `u3d prettify`: Prettify a saved editor logfile
[Information on how `prettify` works](https://github.com/DragonBox/u3d/blob/master/LOG_RULES.md)
-* `u3d dependencies`: [Linux] Install dependencies that Unity don't install by default on Linux.
+* `u3d dependencies`: [Linux] Install dependencies that Unity don't install by default on Linux
+* `u3d licenses`: display information about your Unity licenses
+
+
+
## Installation
```shell
gem install u3d
```
## Unity versions numbering
-Unity3d uses the following version formatting: 0.0.0x0. The \'x\' can takes different values:
- * 'f' are the main release candidates for Unity3d
+Unity uses the following version formatting: 0.0.0x0. The \'x\' can takes different values:
+ * 'f' are the main release candidates for Unity
* 'p' are patches fixing those releases
* 'b' are the beta releases
* 'a' are the alpha releases (not currently discovered online)
Some versions are known to have a different numbering, e.g. Linux 2017.1.0f3 is named 2017.1.0xf3Linux. Its `ProjectSettings/ProjectVersion.txt` will contain the Linux specific version.
@@ -84,11 +89,11 @@
* on Linux, versions are installed under `/opt/unity-editor-$version`
* on Windows, versions are installed under `C:/Program Files/Unity_$version`
u3d should be able to find the different unity installed under those locations. If the Unity installations are not in those locations, u3d might not find them automatically.
-## Sanitize / standardize Unity3d installation paths
+## Sanitize / standardize Unity installation paths
If you have installed Unity in different locations, u3d might discover them and propose you to move them to its standard location. The procedure should be self described and easily revertible (manually). This sanitization operation is only proposed in interactive mode (i.e. if you are not using u3d unattended, e.g. in a build script on a CI server).
@@ -134,10 +139,10 @@
```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:
+* Open the proper Unity for the current project, displaying the raw editor logs in the command line:
```shell
u3d run -r
```