Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document u3d usage on CI servers and how-to troubleshoot #151

Merged
merged 4 commits into from
Sep 27, 2017
Merged

docs: document u3d usage on CI servers and how-to troubleshoot #151

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbfbdd3
docs: document u3d usage on CI servers
lacostej Sep 27, 2017
d2b0c49
docs: add section on troubleshooting
lacostej Sep 27, 2017
c46f344
docs: move SSL errors under troubleshooting section
lacostej Sep 27, 2017
c8a61ce
doc: fix title formatting
lacostej Sep 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
U3D
###
# U3D

[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/DragonBox/u3d/blob/master/LICENSE)
[![Gem](https://img.shields.io/gem/v/u3d.svg?style=flat)](https://rubygems.org/gems/u3d)
Expand All @@ -8,6 +7,8 @@ U3D

U3d is a set of tools to interact with Unity3D from command line. It is available on Linux, Macintosh and Windows.

---

## What can it do?

U3d provides help for running and installing unity from CLI.
Expand Down Expand Up @@ -139,7 +140,23 @@ u3d run -r

You can get further information on how to use U3d by running `u3d --help` (or `u3d -h`).

## SSL Error
## How-tos

### Reuse u3d install on a CI environment

Here you have multiple options

* pass the password using `U3D_PASSWORD` environment variable

* if on Mac, use the keychain option (you set it before hand on the machine, e.g. from the command line using `u3d credentials` add (use `u3d credentials check` to verify) and then use `u3d install -k` to activate the keychain while installing.

### Troubleshoot

Use the global `--verbose` argument to enable debug logs.

Use the global `-t` argument to display stack traces if a crash occurs.

### Solve SSL Errors

If you face an issue similar to this one

Expand Down