aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-08-06 17:09:58 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-08-06 17:09:58 -0500
commitad86c450f2c98daeb01b950588a324c5b31ef696 (patch)
treed8556ee52be40957295ec4ada65e8d9d9eb0cd85
parentAdd Badges (diff)
downloadlocusts-ad86c450f2c98daeb01b950588a324c5b31ef696.tar
locusts-ad86c450f2c98daeb01b950588a324c5b31ef696.tar.gz
locusts-ad86c450f2c98daeb01b950588a324c5b31ef696.tar.bz2
locusts-ad86c450f2c98daeb01b950588a324c5b31ef696.tar.lz
locusts-ad86c450f2c98daeb01b950588a324c5b31ef696.tar.xz
locusts-ad86c450f2c98daeb01b950588a324c5b31ef696.tar.zst
locusts-ad86c450f2c98daeb01b950588a324c5b31ef696.zip
Add more C# documentation and descriptions to the NuGet package
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to '')
-rw-r--r--src/Locusts.cs2
-rw-r--r--src/Locusts.csproj62
-rw-r--r--tests/Locusts.Testing.csproj33
3 files changed, 50 insertions, 47 deletions
diff --git a/src/Locusts.cs b/src/Locusts.cs
index 1082c60..43f758d 100644
--- a/src/Locusts.cs
+++ b/src/Locusts.cs
@@ -10,6 +10,8 @@ public static class Locusts
/// </summary>
/// <remarks>
/// This method will introduce locusts into your codebase.
+ ///
+ /// Locusts are not included with this library, you must provide your own.
/// </remarks>
public static void IntroduceLocusts()
{
diff --git a/src/Locusts.csproj b/src/Locusts.csproj
index f646597..b160d32 100644
--- a/src/Locusts.csproj
+++ b/src/Locusts.csproj
@@ -1,37 +1,37 @@
<Project Sdk="Microsoft.NET.Sdk">
- <PropertyGroup Condition="'$(CI)' == 'true'">
- <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
- </PropertyGroup>
+ <PropertyGroup Condition="'$(CI)' == 'true'">
+ <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+ </PropertyGroup>
- <PropertyGroup>
- <TargetFramework>netstandard2.0</TargetFramework>
- <LangVersion>latest</LangVersion>
- <IsPackable>true</IsPackable>
- <IsTrimmable
- Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0'))">true</IsTrimmable>
- <IsAotCompatible
- Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net7.0'))">true</IsAotCompatible>
- <ImplicitUsings>enable</ImplicitUsings>
- <Nullable>enable</Nullable>
+ <PropertyGroup>
+ <TargetFramework>netstandard2.0</TargetFramework>
+ <LangVersion>latest</LangVersion>
+ <IsPackable>true</IsPackable>
+ <IsTrimmable Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0'))">true</IsTrimmable>
+ <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net7.0'))">true</IsAotCompatible>
+ <ImplicitUsings>enable</ImplicitUsings>
+ <Nullable>enable</Nullable>
- <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
- <PackageLicenseExpression>0BSD</PackageLicenseExpression>
- <PackageReadmeFile>docs/.NET.md</PackageReadmeFile>
- <RepositoryURL>https://github.com/locusts-r-us/locusts</RepositoryURL>
- <RepositoryType>git</RepositoryType>
- <GenerateDocumentationFile>True</GenerateDocumentationFile>
- <IncludeSymbols>True</IncludeSymbols>
- <SymbolPackageFormat>snupkg</SymbolPackageFormat>
- <EmbedUntrackedSources>true</EmbedUntrackedSources>
- </PropertyGroup>
+ <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+ <PackageLicenseExpression>0BSD</PackageLicenseExpression>
+ <PackageReadmeFile>docs/.NET.md</PackageReadmeFile>
+ <RepositoryURL>https://github.com/locusts-r-us/locusts</RepositoryURL>
+ <RepositoryType>git</RepositoryType>
+ <GenerateDocumentationFile>True</GenerateDocumentationFile>
+ <IncludeSymbols>True</IncludeSymbols>
+ <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+ <EmbedUntrackedSources>true</EmbedUntrackedSources>
+ <Title>Locusts</Title>
+ <Description>A .NET library that introduces locusts into your codebase.</Description>
+ </PropertyGroup>
- <ItemGroup>
- <None Include="../docs/.NET.md" Pack="true" PackagePath="docs" />
- <PackageReference Include="Microsoft.SourceLink.GitHub" Version="*-*" PrivateAssets="all" />
- <PackageReference Include="MinVer" Version="*-*">
- <PrivateAssets>all</PrivateAssets>
- <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
- </PackageReference>
- </ItemGroup>
+ <ItemGroup>
+ <None Include="..\docs\.NET.md" Pack="true" PackagePath="docs" />
+ <PackageReference Include="Microsoft.SourceLink.GitHub" Version="*-*" PrivateAssets="all" />
+ <PackageReference Include="MinVer" Version="*-*">
+ <PrivateAssets>all</PrivateAssets>
+ <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+ </PackageReference>
+ </ItemGroup>
</Project> \ No newline at end of file
diff --git a/tests/Locusts.Testing.csproj b/tests/Locusts.Testing.csproj
index fc77ecf..3af0cf6 100644
--- a/tests/Locusts.Testing.csproj
+++ b/tests/Locusts.Testing.csproj
@@ -1,22 +1,23 @@
<Project Sdk="Microsoft.NET.Sdk">
- <PropertyGroup>
- <TargetFramework>net8.0</TargetFramework>
- <ImplicitUsings>enable</ImplicitUsings>
- <Nullable>enable</Nullable>
+ <PropertyGroup>
+ <TargetFramework>netstandard2.0</TargetFramework>
+ <LangVersion>latest</LangVersion>
+ <ImplicitUsings>enable</ImplicitUsings>
+ <Nullable>enable</Nullable>
- <IsPackable>false</IsPackable>
- <IsTestProject>true</IsTestProject>
- </PropertyGroup>
+ <IsPackable>false</IsPackable>
+ <IsTestProject>true</IsTestProject>
+ </PropertyGroup>
- <ItemGroup>
- <PackageReference Include="Microsoft.NET.Test.Sdk" Version="*-*" />
- <PackageReference Include="MSTest.TestAdapter" Version="*-*" />
- <PackageReference Include="MSTest.TestFramework" Version="*-*" />
- <PackageReference Include="coverlet.collector" Version="*-*" />
- </ItemGroup>
+ <ItemGroup>
+ <PackageReference Include="Microsoft.NET.Test.Sdk" Version="*-*" />
+ <PackageReference Include="MSTest.TestAdapter" Version="*-*" />
+ <PackageReference Include="MSTest.TestFramework" Version="*-*" />
+ <PackageReference Include="coverlet.collector" Version="*-*" />
+ </ItemGroup>
- <ItemGroup>
- <ProjectReference Include="..\src\Locusts.csproj" />
- </ItemGroup>
+ <ItemGroup>
+ <ProjectReference Include="..\src\Locusts.csproj" />
+ </ItemGroup>
</Project>