Merge pull request #18 from Lordfirespeed/main

Include README in distributions

Author: Lordfirespeed

Directory.Build.props

@@ -9,6 +9,7 @@
     <PackageProjectUrl>https://github.com/EvaisaDev/UnityNetcodePatcher</PackageProjectUrl>
     <RepositoryUrl>https://github.com/EvaisaDev/UnityNetcodePatcher</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <!-- MinVer -->
@@ -22,4 +23,8 @@
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
   </ItemGroup>
+  
+  <ItemGroup>
+    <None Include="$(ProjectDir)../README.md" Pack="true" PackagePath="/"/>
+  </ItemGroup>
 </Project>

NetcodePatcher.Cli/NetcodePatcher.Cli.csproj

@@ -34,7 +34,8 @@
       <LegacyPackagePackedFile>$(LegacyPackageDistDir)NetcodePatcher-$(MinVerMajor).$(MinVerMinor).$(MinVerPatch)-$(TargetPlatformName).zip</LegacyPackagePackedFile>
     </PropertyGroup>
     <ItemGroup>
-      <LegacyPackageFiles Include="$(OutputPath)/net8.0/*.dll" />
+      <LegacyPackageFiles Include="$(ProjectDir)../README.md"/>
+      <LegacyPackageFiles Include="$(OutputPath)/net8.0/*.dll"/>
       <LegacyPackageFiles Include="$(OutputPath)/net8.0/NetcodePatcher*"/>
     </ItemGroup>
 

README.md

@@ -13,7 +13,7 @@
 *Note, this is intended to be a tool for modders, mods should be shipped after patching and this tool should not be installed by users.*
 
 ## Preparing mods for patching
-- Make sure Debug Symbols is set to `Portable` and not embedded.
+- Make sure Debug Symbols are set to `Portable` or `Embedded` and not `Full`.
 - To ensure that the patched NetworkBehaviours are initialized properly, add the following code snippet to your mod, in a place where it will only run once, such as `Awake()`
 	- **It is very important that it only runs once!**
 	```cs