Skip to content

Small README Update #84

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.

Sign up for GitHub

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
andreiborodin merged 1 commit into from
Dec 11, 2019
Merged

Small README Update #84

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 33 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,43 +10,16 @@ The samples included in this repository best convey the simplicity and value of
- [Simple NuGet Dependency Sample](Samples/SimpleNuGetDependency.Unity/README.md) - Showcases the simplest and most minimal usage of this component to pull in a dependency.
- [Integrated Dependencies Sample](Samples/IntegratedDependencies.Unity/README.md) - Showcases the power of this component by relying on project generation.

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

### Prerequisites

The following tools are required to contribute to this project:
- [Visual Studio 2017+](https://visualstudio.microsoft.com/downloads)
- [Unity 2018+](https://unity3d.com/get-unity/download)

To get started, clone the repo, and then run `git submodule update --init` to initialize submodules.

### Builds and Packages

| Build | Status |
|-------|------------------------------------------------------|
| UPM | [![UPM Build Status][UPMBuildBadge]][UPMBuild] |
| NuGet | [![NuGet Build Status][NuGetBuildBadge]][NuGetBuild] |

| Package | Feed |
|---------|-----------------------------------------------------------------------------------------------------------------------|
| UPM | [Azure DevOps](https://dev.azure.com/UnityDeveloperTools/MSBuildForUnity/_packaging?_a=feed&feed=UnityDeveloperTools) |
| NuGet | [![NuGet Package][NuGetPackageBadge]][NuGetPackage] |
| Build | Build Status | Package Feed |
|-------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| UPM | [![UPM Build Status][UPMBuildBadge]][UPMBuild] | [Azure DevOps](https://dev.azure.com/UnityDeveloperTools/MSBuildForUnity/_packaging?_a=feed&feed=UnityDeveloperTools) |
| NuGet | [![NuGet Build Status][NuGetBuildBadge]][NuGetBuild] | [![NuGet Package][NuGetPackageBadge]][NuGetPackage] |

## Quick Start

Following are basic instructions for taking advantage of MSBuildForUnity for some common scenarios.
The following are basic instructions for taking advantage of MSBuildForUnity for some common scenarios.

### Scenario 1: Bring NuGet packages and MSBuild projects into a Unity project

Expand All @@ -55,6 +28,7 @@ This scenario leverages the MSBuildForUnity [Project Builder](#msbuild-project-b
1. Add the `com.microsoft.msbuildforunity` UPM (Unity Package Manager) package.
- Edit the `Packages/manifest.json` file in your Unity project.
- Add the following near the top of the file:

```json
"scopedRegistries": [
{
Expand All @@ -66,11 +40,15 @@ This scenario leverages the MSBuildForUnity [Project Builder](#msbuild-project-b
}
],
```

- Add the following to the `dependencies` section of the file:

```json
"com.microsoft.msbuildforunity": "0.8.3"
```

1. Create a "SDK style" MSBuild project (e.g. csproj) somewhere under your `Assets` directory of your Unity project that references the `MSBuildForUnity` NuGet package. Here is an example:

```xml
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
Expand All @@ -84,6 +62,7 @@ This scenario leverages the MSBuildForUnity [Project Builder](#msbuild-project-b
</ItemGroup>
</Project>
```

1. Add additional references to any NuGet packages you want to use in your Unity project.

## Features
Expand Down Expand Up @@ -124,3 +103,25 @@ For details, see the [documentation](Documentation/MSBuildForUnityNuGetPackage/M

[NuGetPackageBadge]: https://feeds.dev.azure.com/UnityDeveloperTools/0cb95e25-9194-4ccd-9afb-439b25ecb93a/_apis/public/Packaging/Feeds/a3d1c3cc-6042-4e05-b699-39a947e75639/Packages/bdf78d31-dd97-4f6b-befb-75bb6185172e/Badge
[NuGetPackage]: https://dev.azure.com/UnityDeveloperTools/MSBuildForUnity/_packaging?_a=package&feed=a3d1c3cc-6042-4e05-b699-39a947e75639&package=bdf78d31-dd97-4f6b-befb-75bb6185172e&preferRelease=true

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

### Prerequisites

The following tools are required to contribute to this project:
- [Visual Studio 2017+](https://visualstudio.microsoft.com/downloads)
- [Unity 2018+](https://unity3d.com/get-unity/download)

To get started, clone the repo, and then run `git submodule update --init` to initialize submodules. |