Skip to content

Commit 3dd6cf5

Browse files
author
Eric Miller
committed
Update README
1 parent 5ed5037 commit 3dd6cf5

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
# UnityBuildKit
99

10-
A description of this package.
10+
`UnityBuildKit` is a command line tool that generates an iOS application with an embedded Unity scene.
1111

1212
## Installation
1313
`UnityBuildKit` requires Xcode 9 and Swift 4
@@ -20,7 +20,8 @@ make
2020
```
2121

2222
## Usage
23-
1. Create a top-level folder that will contain all information about the Xcode and Unity projects and navigate to that folder. (_Note: By default, the name of this folder will be the name of the Xcode and Unity projects._)
23+
### To generate a new project
24+
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._)
2425
```
2526
mkdir ExampleProject
2627
cd ExampleProject
@@ -40,13 +41,20 @@ cd ExampleProject
4041

4142
3. Run `UnityBuildKit` in Terminal
4243

44+
45+
46+
## Known Unity Version Compatibility
47+
- 2107.1.f1
48+
4349
## Attributions
4450
This tool is built using:
4551
- [XcodeGen](https://github.com/yonaskolb/XcodeGen)
4652
- [xcproj](https://github.com/xcodeswift/xcproj)
4753

4854
and the wonderful dependencies they bring with them.
4955

56+
Inspiration for building `UnityBuildKit` came after running into several problems while trying to [manually do this process](https://the-nerd.be/2015/11/13/integrate-unity-5-in-a-native-ios-app-with-xcode-7/) and reading over a [github issue](https://github.com/blitzagency/ios-unity5/issues/52) trying to resolve those problems.
57+
5058
## License
5159

5260
UnityBuildKit is licensed under the MIT license. See LICENSE for more info.

0 commit comments

Comments
 (0)