Updating the main Readme.md #50
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
keveleigh
approved these changes
Nov 14, 2019
ryantrem
reviewed
Nov 14, 2019
| @@ -1,9 +1,15 @@ | |||
| # MSBuildForUnity | |||
|
|
|||
| MSBuildForUnity is a [collection of tools](#features) to help integrate MSBuild with Unity. This is helpful in leveraging more of the .NET ecosystem within Unity. Some things this project helps with are: | |||
| - Sharing code (via an MSBuild project) between Unity and other .NET projects (such as UWP XAML apps, Xamarin apps, etc.). | |||
| MSBuildForUnity solves the problem of establishing a clear dependency relationships between Unity project and other .NET components such as external (to Unity) C# projects, or NuGet packages. It creates a familiar to .NET developers project structure and ensures that the dependencies are resolves and brought into the Unity project as appropriate. With this component, you can: | |||
There was a problem hiding this comment.
"resolves" should be "resolved"
andreiborodin
pushed a commit
that referenced
this pull request
Nov 19, 2019
* Added a Unity project with reference to MSBuildForUnity and 2 asmdef to signify two components * Added props/targets templates, and also refactored to exporter model * More changes, plus some sample updates * Perf Improvements in preparation of External Depedencies (#42) * Misc cleanup, also refactor a bit more csprojectinfo and exporter relationship * Rewrote the template process for XML, haven't replaced existing process yet. * Various perf improvements, also removed need to create PackageCopy * Implemented TextFileTemplate * A few more minor changes * A bit of cleanup * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Exporters/IProjectExporter.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/Xml/XmlCommentTemplateToken.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/TemplateReplacementSet.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/ITemplatePart.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Exporters/TemplatedProjectExporter.cs Co-Authored-By: Kurtis <[email protected]> * Removing commented code * Replace Source File references with Folder Includes (#43) * Misc cleanup, also refactor a bit more csprojectinfo and exporter relationship * Rewrote the template process for XML, haven't replaced existing process yet. * Various perf improvements, also removed need to create PackageCopy * Implemented TextFileTemplate * A few more minor changes * A bit of cleanup * Added support for including on soure file locations and excluding on source file locations * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Exporters/IProjectExporter.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/Xml/XmlCommentTemplateToken.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/TemplateReplacementSet.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/ITemplatePart.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Exporters/TemplatedProjectExporter.cs Co-Authored-By: Kurtis <[email protected]> * Removing commented code * Update Generated Project Structure (#45) * Misc cleanup, also refactor a bit more csprojectinfo and exporter relationship * Rewrote the template process for XML, haven't replaced existing process yet. * Various perf improvements, also removed need to create PackageCopy * Implemented TextFileTemplate * A few more minor changes * A bit of cleanup * Added support for including on soure file locations and excluding on source file locations * First iteration of updating project structure * Updated the structure, and ensured standard scenarios still work * Added an example of external nuget package reference * Added the NuGet dependency example that has minimum requirement of MSBuildForUnity * Adding settings json file * Fixed an error * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/TemplateReplacementSet.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/Xml/XmlCommentTemplateToken.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Templates/ITemplatePart.cs Co-Authored-By: Kurtis <[email protected]> * Update Source/MSBuildTools.Unity/Packages/com.microsoft.msbuildforunity/Editor/ProjectGenerator/Scripts/Exporters/IProjectExporter.cs Co-Authored-By: Kurtis <[email protected]> * Updating templates with comments * Minor updates * Simple NuGet Dependency Sample (#46) * Udpating the sample to be a simple nuget dependency * Added Readme for the simple nuget package sample * Integrated Dependencies (#49) * Updating project generator to support Dependencies project * Checking in initial version of the sample * Exclude dependencies folder from participating in contributing plugins to the csproject files generated * Added the generated projects that can be checked-in * Made use of JSOn * Trying to get external reference to be included * Fixed up most of the things needed to make supported integrated dependencies * More fixes * Completed the Readme.md * Fixing switching platforms * Updated documentaiton * Updating project generator to support Dependencies project * Checking in initial version of the sample * Exclude dependencies folder from participating in contributing plugins to the csproject files generated * Added the generated projects that can be checked-in * Made use of JSOn * Sign dlls and package (#39) This change updates the NuGet package build to sign MSBuildForUnity.dll as well as the NuGet package itself. Break the existing build step into two separate steps (build and package) Add a step for signing binaries between building and packaging Add a step for signing the package * Add NuGet package badge and link to readme (#41) * Trying to get external reference to be included * Sign third party components (#47) The primary change here is to sign third party components (Newtonsoft.Json and Mono.Cecil) and include them in the NuGet package: - Update MSBuildForUnity.csproj to ensure third party components are copied to the output directory (so we can sign them), and make sure they are then packaged up with the NuGet package. - Update the code signing steps to sign the third party components. I also made a couple related changes:: - Replace the Mono.Cecil submodule with the actual NuGet package (an updated package was published a few days ago with the bug fixes we needed). - Add the ComponentGovernanceComponentDetection step to check for third party components with any known problems (we shouldn't ship such components). * Move GenerateAssetId into a custom C# task, since CodeTaskFactory is not compatible with dotnet (#48) * Fixed up most of the things needed to make supported integrated dependencies * More fixes * Completed the Readme.md * Fixing switching platforms * Updated documentaiton * Updating project generator to support Dependencies project * Checking in initial version of the sample * Exclude dependencies folder from participating in contributing plugins to the csproject files generated * Added the generated projects that can be checked-in * Made use of JSOn * Trying to get external reference to be included * rebase * Sign third party components (#47) The primary change here is to sign third party components (Newtonsoft.Json and Mono.Cecil) and include them in the NuGet package: - Update MSBuildForUnity.csproj to ensure third party components are copied to the output directory (so we can sign them), and make sure they are then packaged up with the NuGet package. - Update the code signing steps to sign the third party components. I also made a couple related changes:: - Replace the Mono.Cecil submodule with the actual NuGet package (an updated package was published a few days ago with the bug fixes we needed). - Add the ComponentGovernanceComponentDetection step to check for third party components with any known problems (we shouldn't ship such components). * Fixed up most of the things needed to make supported integrated dependencies * More fixes * Completed the Readme.md * Fixing switching platforms * Updated documentaiton * Updating project generator to support Dependencies project * Checking in initial version of the sample * Added the generated projects that can be checked-in * Trying to get external reference to be included * Fixed up most of the things needed to make supported integrated dependencies * More fixes * Completed the Readme.md * Fixing switching platforms * Updated documentaiton * minor fixes * One more change * Responding to Kurtis' comments * Updating the main Readme.md (#50) * Updating versioning (#51) * Update README.md * Update package.json * Moved where Unity Major/Minor version is specified (#52) * Added the current MSBuildForUnityVersion * Responding to Ryan's changes * Moved Dependencies project * Re-enabled default profiles * Undoing auto-formatting * Flipped backslash to forward slash
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updating the main readme following introductions of samples.