From 8f2caa305cc5cefcf38d5a924ce3e19fa38d3cc3 Mon Sep 17 00:00:00 2001 From: Dylan Wilson Date: Tue, 21 Mar 2017 22:10:49 +1000 Subject: [PATCH] updated the nuget package readme files and made every nuget package show the readme on install --- Source/MonoGame.Extended.Animations.nuspec | 2 ++ .../readme.txt | 17 +++++++++++--- Source/MonoGame.Extended.Entities.nuspec | 2 ++ Source/MonoGame.Extended.Graphics.nuspec | 2 ++ Source/MonoGame.Extended.Gui.nuspec | 2 ++ Source/MonoGame.Extended.Input.nuspec | 2 ++ Source/MonoGame.Extended.NuclexGui.nuspec | 2 ++ Source/MonoGame.Extended.Particles.nuspec | 2 ++ Source/MonoGame.Extended.SceneGraphs.nuspec | 2 ++ Source/MonoGame.Extended.Tiled.nuspec | 2 ++ Source/MonoGame.Extended.Tweening.nuspec | 2 ++ Source/readme.txt | 23 +++++++++++-------- 12 files changed, 48 insertions(+), 12 deletions(-) diff --git a/Source/MonoGame.Extended.Animations.nuspec b/Source/MonoGame.Extended.Animations.nuspec index 44aac4f8..0f3efadc 100644 --- a/Source/MonoGame.Extended.Animations.nuspec +++ b/Source/MonoGame.Extended.Animations.nuspec @@ -29,5 +29,7 @@ + + diff --git a/Source/MonoGame.Extended.Content.Pipeline/readme.txt b/Source/MonoGame.Extended.Content.Pipeline/readme.txt index 26863847..6033b8a4 100644 --- a/Source/MonoGame.Extended.Content.Pipeline/readme.txt +++ b/Source/MonoGame.Extended.Content.Pipeline/readme.txt @@ -1,5 +1,16 @@ - -# MonoGame.Extended.Content.Pipeline +# MonoGame.Extended.Content.Pipeline -This should be shown when the package is installed. +This NuGet package is intended to be used with the MonoGame Content Pipeline. You'll need to +make some changes to your Content Pipline file (usually Content.mgcb) for everything to work +properly. +Add a reference to the `MonoGame.Extended.Content.Pipeline.dll` now installed in your `packages` folder +to the [MonoGame Content Pipeline tool](http://www.monogame.net/documentation/?page=Pipeline). + +You can do this either with the Reference Editor in the GUI or by manually adding a reference line to +your `Content.mgcb` file. + +**Remember**: the versions need to match exactly for everything to work. + +For full instructions see the [How to install MonoGame.Extended](https://github.com/craftworkgames/MonoGame.Extended/wiki/How-to-install-MonoGame.Extended) +wiki page. diff --git a/Source/MonoGame.Extended.Entities.nuspec b/Source/MonoGame.Extended.Entities.nuspec index 436d3a77..89a0ae9b 100644 --- a/Source/MonoGame.Extended.Entities.nuspec +++ b/Source/MonoGame.Extended.Entities.nuspec @@ -31,5 +31,7 @@ + + diff --git a/Source/MonoGame.Extended.Graphics.nuspec b/Source/MonoGame.Extended.Graphics.nuspec index 1536a2a7..83f09ca7 100644 --- a/Source/MonoGame.Extended.Graphics.nuspec +++ b/Source/MonoGame.Extended.Graphics.nuspec @@ -31,5 +31,7 @@ + + diff --git a/Source/MonoGame.Extended.Gui.nuspec b/Source/MonoGame.Extended.Gui.nuspec index fd1011ac..20bdc0b7 100644 --- a/Source/MonoGame.Extended.Gui.nuspec +++ b/Source/MonoGame.Extended.Gui.nuspec @@ -30,5 +30,7 @@ + + diff --git a/Source/MonoGame.Extended.Input.nuspec b/Source/MonoGame.Extended.Input.nuspec index 5c482483..bda4cc8e 100644 --- a/Source/MonoGame.Extended.Input.nuspec +++ b/Source/MonoGame.Extended.Input.nuspec @@ -29,5 +29,7 @@ + + diff --git a/Source/MonoGame.Extended.NuclexGui.nuspec b/Source/MonoGame.Extended.NuclexGui.nuspec index 17ea4083..a753a464 100644 --- a/Source/MonoGame.Extended.NuclexGui.nuspec +++ b/Source/MonoGame.Extended.NuclexGui.nuspec @@ -30,5 +30,7 @@ + + diff --git a/Source/MonoGame.Extended.Particles.nuspec b/Source/MonoGame.Extended.Particles.nuspec index 36aebfe9..0dfa915b 100644 --- a/Source/MonoGame.Extended.Particles.nuspec +++ b/Source/MonoGame.Extended.Particles.nuspec @@ -29,5 +29,7 @@ + + diff --git a/Source/MonoGame.Extended.SceneGraphs.nuspec b/Source/MonoGame.Extended.SceneGraphs.nuspec index 3c407ba2..eb47e83d 100644 --- a/Source/MonoGame.Extended.SceneGraphs.nuspec +++ b/Source/MonoGame.Extended.SceneGraphs.nuspec @@ -29,5 +29,7 @@ + + diff --git a/Source/MonoGame.Extended.Tiled.nuspec b/Source/MonoGame.Extended.Tiled.nuspec index 2ab35964..2b5f7e56 100644 --- a/Source/MonoGame.Extended.Tiled.nuspec +++ b/Source/MonoGame.Extended.Tiled.nuspec @@ -30,5 +30,7 @@ + + diff --git a/Source/MonoGame.Extended.Tweening.nuspec b/Source/MonoGame.Extended.Tweening.nuspec index 7edb8f0e..a47a43e2 100644 --- a/Source/MonoGame.Extended.Tweening.nuspec +++ b/Source/MonoGame.Extended.Tweening.nuspec @@ -30,5 +30,7 @@ + + diff --git a/Source/readme.txt b/Source/readme.txt index ed90ec52..e7b0b3e7 100644 --- a/Source/readme.txt +++ b/Source/readme.txt @@ -1,16 +1,21 @@ -## How to install +## Welcome to MonoGame.Extended -See the [How to install MonoGame.Extended](https://github.com/craftworkgames/MonoGame.Extended/wiki/How-to-install-MonoGame.Extended) wiki page. +MonoGame.Extended is a collection of NuGet packages that make MonoGame more awesome. -The package comes with 2 DLLs: - - MonoGame.Extended.dll - - MonoGame.Extended.Content.Pipeline.dll - -The `MonoGame.Extended.Content.Pipeline.dll` is intended to be used with the [Pipeline tool](http://www.monogame.net/documentation/?page=Pipeline). -To reference the DLL in the Pipeline tool please edit your `Content.mgcb` file and add a reference to it. -**Remember**: the versions need to match exactly for everything to work. +## IMPORTANT! + +To get the full experience you'll also need to install an additional NuGet package: + + - MonoGame.Extended.Content.Pipeline + +Once you've installed that package, follow the instructions to add it to your +Content Pipeline. + + + +## Check out the other packages There's also a few other NuGet packages available including: