Skip to content

Commit d28f551

Browse files
author
Eric Miller
committed
Update README
1 parent ad937c4 commit d28f551

File tree

1 file changed

+8
-24
lines changed

1 file changed

+8
-24
lines changed

README.md

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,46 +35,30 @@ make
3535
```
3636

3737
## Usage
38-
### To generate a new project
39-
Currently, Unity needs to be closed for this process to begin.
38+
### To generate new iOS and Unity projects
39+
_Currently, Unity needs to be closed for this process to begin._
4040

4141
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._)
4242
```
4343
mkdir ExampleProject
4444
cd ExampleProject
4545
```
4646

47-
2. Run the following to generate the `ubconfig.json` file where you can specify project names and paths
47+
2. Run the following to generate the `ubconfig.json` file where you can specify project information
4848
```
49-
UnityBuildKit init
49+
UnityBuildKit config
5050
```
5151

5252
3. After filling out the config file information, run
5353
```
5454
$ UnityBuildKit generate
5555
```
5656

57-
4. Once generation is complete, open the Xcode project. Using the Build Scheme drop down menu, select Edit Scheme to edit your project's scheme (the scheme should be the same name as your project). Select the Run action then the Options tab. In the middle of the window, you will see `Metal API Validation` with a set of options in a drop down menu. Change the current option to `Disabled`, as seen below:
58-
![](Assets/metal_validation_scheme.png)
59-
_(Note: if you do not see the option for Metal API Validation, verify your run destination is a physical device of set to Generic iOS Device)_
60-
6157
#### Notes
62-
- The generation script sets up the Unity project to build for the Device SDK. These means that, if building for a simulator, there is a high probability that you will encounter build and linker errors in Xcode. Change the run destination to a physical device and the errors should go away.
63-
64-
- If building for a physical device, do not forget to set up your code signing.
65-
66-
### To refresh the Xcode project
67-
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.
58+
- The generation script sets up the Unity project to build for the Device SDK. These means that, if building for a simulator, there is a high probability that you will encounter build and linker errors in Xcode. Change the run destination to a physical device and the errors should go away. You can change this in Unity using the Build Settings once generation is completed.
6859

69-
1. Navigate to the top-level folder
70-
```
71-
cd ExampleProject
72-
```
73-
74-
2. Run
75-
```
76-
UnityBuildKit refresh
77-
```
60+
### Refreshing the projects
61+
The iOS project is automatically updated and refreshed every time the Unity project is built. You shouldn't need to do anything! 😀
7862

7963
## Known Unity Version Compatibility
8064
- 2107.1.f1
@@ -86,7 +70,7 @@ This tool is built using:
8670

8771
and the wonderful dependencies they bring with them.
8872

89-
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.
73+
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 (big thanks to [jiulongw](https://github.com/jiulongw/swift-unity)).
9074

9175
## License
9276

0 commit comments

Comments
 (0)