Skip to content

Commit 10df641

Browse files
author
Eric Miller
committed
Update README
1 parent 9ba9e82 commit 10df641

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<p>
2-
<img src="https://img.shields.io/badge/version-0.7.0-blue.svg?style=flat-square" />
2+
<img src="https://img.shields.io/badge/version-0.8.0-blue.svg?style=flat-square" />
33
<a href="https://github.com/handsomecode/UnityBuildKit/blob/master/LICENSE">
44
<img src="https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square"/>
55
</a>
66
</p>
77

88
# UnityBuildKit
99

10-
UnityBuildKit is a command line tool that generates an iOS application with an embedded Unity scene.
10+
UnityBuildKit is a command line tool that embeds a Unity project into an iOS application. Both the Xcode and Unity project are automatically created, configured, and linked for immediate use after successful generation.
1111

1212
## Installation
13-
`UnityBuildKit` requires Xcode 9 and Swift 4
13+
`UnityBuildKit` requires Xcode 9, Swift 4, and Unity
1414

1515
### Make
1616
```
@@ -27,6 +27,8 @@ make
2727

2828
## Usage
2929
### To generate a new project
30+
Currently, Unity needs to be closed for this process to begin.
31+
3032
1. Create a top-level folder and navigate to it. This folder will contain all information about the Xcode and Unity projects. (_Note: By default, the name of this folder will be the name of the Xcode and Unity projects._)
3133
```
3234
mkdir ExampleProject
@@ -50,6 +52,19 @@ cd ExampleProject
5052
$ UnityBuildKit generate
5153
```
5254

55+
### To refresh the Xcode project
56+
After making updates to your Unity project, you'll need to refresh the files linked with the Xcode project. Currently, Unity needs to be closed for this process to begin.
57+
58+
1. Navigate to the top-level folder
59+
```
60+
cd ExampleProject
61+
```
62+
63+
2. Run
64+
```
65+
UnityBuildKit refresh
66+
```
67+
5368
## Known Unity Version Compatibility
5469
- 2107.1.f1
5570

0 commit comments

Comments
 (0)