Skip to content

Commit 27cf878

Browse files
committed
docs: Updated readme to reflect that this is no longer a submodule
1 parent a43d420 commit 27cf878

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
55
[![CLA assistant](https://cla-assistant.io/readme/badge/IBM/unity-sdk-core)](https://cla-assistant.io/IBM/unity-sdk-core)
66

7-
The IBM Cloud Unity SDK Core is a core project of Unity SDKs generated using the IBM OpenAPI SDK generator. Generated services should use this package as a submodule of their generate Unity SDK.
7+
The IBM Cloud Unity SDK Core is a core project of Unity SDKs generated using the IBM OpenAPI SDK generator. The core should be added to the **`Assets`** directory of your Unity project
88

99
<details>
1010
<summary>Table of Contents</summary>
@@ -29,14 +29,9 @@ Ensure that you have the following prerequisites:
2929
* If using Unity 2018.2 or later you'll need to set **Scripting Runtime Version** and **Api Compatibility Level** in Build Settings to **.NET 4.x equivalent**. We need to access security options to enable TLS 1.2.
3030

3131
## Getting the IBM Unity SDK Core and adding it to Unity
32-
The IBM Unity SDK Core is mean to be used as a submodule in other generated Unity SDKs. The selected SDK release will point to a particular commit of the IBM Unity SDK Core. Clone the SDK into your Unity project's Assets directory, and initalize and update submodules.
32+
You can get the latest SDK Core release by clicking [here][latest_release_core].
3333

34-
```bash
35-
$ git clone [unity-sdk-url]
36-
$ cd [unity-sdk-directory]
37-
$ git submodule init
38-
$ git submodule update
39-
```
34+
The IBM Unity SDK Core is a dependency of Unity SDKs generated using the IBM OpenAPI SDK generator. It should be added to the **`Assets`** directory of your Unity project. _Optional: rename the Core directory from `unity-sdk-core` to `IBMSdkCore`_.
4035

4136
## Questions
4237

@@ -54,3 +49,4 @@ This library is licensed under Apache 2.0. Full license text is available in [LI
5449
See [CONTRIBUTING.md](.github/CONTRIBUTING.md).
5550

5651
[get_unity]: https://unity3d.com/get-unity
52+
[latest_release_core: https://github.com/IBM/unity-sdk-core/releases/latest

0 commit comments

Comments
 (0)