Skip to content

Submodule revisions #2

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.

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

Merged
merged 3 commits into from
Apr 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.0.1
current_version = v0.1.0
commit = True
message = [skip ci] docs: Update version numbers from {current_version} -> {new_version}

Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,5 @@ IBMService.cs.meta
Logging.meta
RequestObject.cs.meta
Tests.meta
Utilities.meta
Utilities.meta
package-lock.json.meta
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![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)
[![CLA assistant](https://cla-assistant.io/readme/badge/IBM/unity-sdk-core)](https://cla-assistant.io/IBM/unity-sdk-core)

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.
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

<details>
<summary>Table of Contents</summary>
Expand All @@ -29,14 +29,9 @@ Ensure that you have the following prerequisites:
* 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.

## Getting the IBM Unity SDK Core and adding it to Unity
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.
You can get the latest SDK Core release by clicking [here][latest_release_core].

```bash
$ git clone [unity-sdk-url]
$ cd [unity-sdk-directory]
$ git submodule init
$ git submodule update
```
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`_.

## Questions

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

[get_unity]: https://unity3d.com/get-unity
[latest_release_core: https://github.com/IBM/unity-sdk-core/releases/latest
6 changes: 3 additions & 3 deletions Utilities/Constants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ public static class String
/// URL for IBM Cloud onboarding
/// </summary>
public const string IBM_CLOUD_URL = "http://console.bluemix.net/registration";
/// <summary>
/// The version of the Unity SDK Core
/// <summary>
/// The version of the Unity SDK Core
/// </summary>
public const string CORE_VERSION = "0.0.1";
public const string CORE_VERSION = "v0.1.0";
}

/// <summary>
Expand Down