amacocian/MonoGame.Extended
1
0
Fork 0
mirror of https://github.com/AlexMacocian/MonoGame.Extended.git synced 2026-07-24 12:06:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated the nuget package readme files and made every nuget package show the readme on install

Browse Source
This commit is contained in:
Dylan Wilson
2017-03-21 22:10:49 +10:00
parent 2405de08b4
commit 8f2caa305c
12 changed files with 48 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Source/MonoGame.Extended.Animations.nuspec
+2
View File
@@ -29,5 +29,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.Animations\bin\Release\MonoGame.Extended.Animations.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.Content.Pipeline/readme.txt
+14 -3
View File
@@ -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.
Source/MonoGame.Extended.Entities.nuspec
+2
View File
@@ -31,5 +31,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.Entities\bin\Release\MonoGame.Extended.Entities.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.Graphics.nuspec
+2
View File
@@ -31,5 +31,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.Graphics\bin\Release\MonoGame.Extended.Graphics.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.Gui.nuspec
+2
View File
@@ -30,5 +30,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.Gui\bin\Release\MonoGame.Extended.Gui.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.Input.nuspec
+2
View File
@@ -29,5 +29,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.Input\bin\Release\MonoGame.Extended.Input.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.NuclexGui.nuspec
+2
View File
@@ -30,5 +30,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.NuclexGui\bin\Release\MonoGame.Extended.NuclexGui.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.Particles.nuspec
+2
View File
@@ -29,5 +29,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.Particles\bin\Release\MonoGame.Extended.Particles.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.SceneGraphs.nuspec
+2
View File
@@ -29,5 +29,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.SceneGraphs\bin\Release\MonoGame.Extended.SceneGraphs.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.Tiled.nuspec
+2
View File
@@ -30,5 +30,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.Tiled\bin\Release\MonoGame.Extended.Tiled.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/MonoGame.Extended.Tweening.nuspec
+2
View File
@@ -30,5 +30,7 @@
</metadata>
<files>
<file src="MonoGame.Extended.Tweening\bin\Release\MonoGame.Extended.Tweening.dll" target="lib" />
<!-- A readme.txt will be displayed when the package is installed -->
<file src="readme.txt" target="" />
</files>
</package>
Source/readme.txt
+14 -9
View File
@@ -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: