Add ReadMe to the NuGet package project

readme.md

@@ -18,6 +18,7 @@ Development is focused on the next major version in the `master` branch. No more
   - Lukas Dürrenberger ([email protected])
   - Chris Thrasher ([email protected])
   - Zachariah Brown ([email protected])
+  - And many other members of the SFML community
 
 ## Download
 

tools/nuget/CSFML/CSFML.csproj

@@ -4,7 +4,7 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 
-    <Version>3.0.0</Version>
+    <Version>3.0.0-rc.2</Version>
     <Authors>Laurent Gomila</Authors>
     <PackageTags>sfml csfml</PackageTags>
     <Copyright>Copyright © Laurent Gomila</Copyright>
@@ -13,6 +13,7 @@
     <PackageProjectUrl>https://www.sfml-dev.org/</PackageProjectUrl>
     <PackageIconUrl>https://www.sfml-dev.org/images/sfml-icon.png</PackageIconUrl>
     <PackageIcon>sfml-icon.png</PackageIcon>
+    <PackageReadmeFile>readme.md</PackageReadmeFile>
 
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <IncludeBuildOutput>false</IncludeBuildOutput>
@@ -31,6 +32,7 @@
     <None Pack="True" Include="runtimes/**" PackagePath="runtimes" />
     <None Pack="True" Include="build/**" PackagePath="build" />
     <None Pack="True" Include="sfml-icon.png" PackagePath="/" />
+    <None Pack="True" Include="readme.md" PackagePath="/" />
   </ItemGroup>
 
 </Project>

tools/nuget/CSFML/readme.md

@@ -0,0 +1,33 @@
+# CSFML - Simple and Fast Multimedia Library for C
+
+SFML is a simple, fast, cross-platform and object-oriented multimedia API.
+It provides access to windowing, graphics, audio and network.
+It is originally written in C++, and this project is its official binding for the C language.
+
+This NuGet package is designed to provide the required native CSFML libraries for SFML.Net.
+
+## Authors
+
+  - Laurent Gomila ([email protected])
+  - Lukas Dürrenberger ([email protected])
+  - Chris Thrasher ([email protected])
+  - Zachariah Brown ([email protected])
+  - And many other members of the SFML community
+
+## Learn
+
+There is no tutorial for CSFML, but since it's a binding you can use the C++ resources:
+
+  * The [official tutorials](https://www.sfml-dev.org/tutorials/)
+  * The [online API documentation](https://www.sfml-dev.org/documentation/)
+  * The [community wiki](https://github.com/SFML/SFML/wiki/)
+  * The [community forum](https://en.sfml-dev.org/forums/) (or [French](https://fr.sfml-dev.org/forums/))
+
+Of course, you can also find the CSFML API documentation in the SDK.
+
+
+## Contribute
+
+SFML and CSFML are open-source projects, and they need your help to go on growing and improving.
+Don't hesitate to post suggestions or bug reports on [the forum](https://en.sfml-dev.org/forums/), or post new bugs/features requests on the [issue tracker](https://github.com/SFML/CSFML/issues/).
+You can even fork the project on GitHub, maintain your own version and send us pull requests periodically to merge your work.