README.md in u3d-1.0.19 vs README.md in u3d-1.0.20

- old
+ new

@@ -59,10 +59,21 @@ ```shell gem install u3d ``` +### Setup + +u3d requires some environment variables set up to run correctly. In particular processing log files requires your locales to be set to a UTF-8 locale. In your shell profile add the following lines: + +``` +export LC_ALL=en_US.UTF-8 +export LANG=en_US.UTF-8 +``` + +You can find your shell profile at ~/.bashrc, ~/.bash_profile or ~/.zshrc depending on your system. + ## Unity versions numbering 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 @@ -70,9 +81,19 @@ * '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. When referencing to a version on the CLI, u3d sanitizes these weird versions. For example, if you ask u3d to launch unity 2017.1.0f3 on Linux, you can use `u3d -u 2017.1.0f3` and it will find "2017.1.0xf3Linux". + +### Unity build numbers + +Every Unity version has a build number in the form of a 12 characters hexadecimal (e.g. `bf5cca3e2788`). You might have noticed them: those build numbers are currently part of the download URLs that `u3d available` displays. + +Most of the time Unity users won't have to pay attention to build numbers. In a few scenarios, they become important. + +For example, sometimes Unity releases multiple builds with the same version but different build numbers, e.g. when releasing hot fixes. If you need a hotfix release, you might need to ensure that you are using it. + +Right now u3d has light support for build numbers. The build number can be found inside the Unity installation files and u3d will extract them and `u3d list` will display both the version and the build number. In the future u3d will have more features to help you managing installations of those special builds. Follow this [request for enhancement](https://github.com/DragonBox/u3d/issues/274) for more information. ## Default Installation paths The standard Unity installer has some quirks: