Skip to content

InfinityFlowApp/tools-nuget-branding

Repository files navigation

InfinityFlow NuGet Branding

GitHub Actions Workflow Status GitHub Release GitHub License

A NuGet package that sets the MSBuild properties such as Authors, PackageIcon, PackageLicenseFile, PackageReadmeFile, Copyright, and puts assets for Package Icon.

Please ensure to revise the License and Readme files taken from the Solution before proceeding with the MSBuild.

Installation

To install this package, use the NuGet Package Manager Console:

PM> Install-Package InfinityFlow.Tools.Branding

Or you can search for "InfinityFlow.Tools.Branding" in the NuGet Package Manager UI and install it from there.

Usage

After installing the package, the MSBuild properties will be set automatically. You can modify the properties by updating the values in your .csproj or .vbproj file.

For example, to set the Authors property, add the following to your .csproj or .vbproj file:

<PropertyGroup>
    <Authors>John Doe;Jane Smith</Authors>
</PropertyGroup>

MSBuild Properties

This package sets the following MSBuild properties:

  • Authors
  • PackageIcon
  • PackageLicenseFile
  • PackageReadmeFile
  • Copyright

You can modify these properties by updating your .csproj or .vbproj file as described in the Usage section.

Assets

This package includes the following assets:

  • PackageIcon: assets/packageIcon.png
  • License: LICENSE
  • Readme file: README.md

To access the assets, use the relative paths shown above.

Except the PackageIcon, License and Readme are taken from Solution Root folder, unless specified differently.

<ItemGroup>
  <None Pack="true" PackagePath="" Include="$(SolutionDir)/LICENSE" />
  <None Pack="true" PackagePath="" Include="$(SolutionDir)/README.md" />
</ItemGroup>

Contributing

If you find a bug or have a feature request, please create an issue in the GitHub repository.

License

This package is released under the MIT License. See the LICENSE file for details.