Template

Table of Contents

• Overview
• Features
• Getting Started
  • Prerequisites
  • Installation
    • NuGet Package
    • Clone the repo
• Usage
  • Notes
• Example of code
• Contributing
• Bug / Issue Reporting
• License
• Contact
• Acknowledgments

Overview

This is a template for creating .NET projects. It includes a basic structure and some common files to get you started quickly.

Change TirsvadCLI/Dotnet.Template with the name of your project. Change NugetPackageName with the name of your nuget package.

Add Doxygen to the project and add a script to generate the documentation.

In project file for library, add the following lines:

  <PropertyGroup>
    <VersionPrefix>0.1.0</VersionPrefix>
    <PackageId>$(AssemblyName)</PackageId>
    <Title></Title>
    <Authors>Jens Tirsvad Nielsen</Authors>
    <Company>TirsvadCLI</Company>
    <PackageIcon>logo.png</PackageIcon>
    <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
    <RepositoryUrl>https://github.com/TirsvadCLI/Dotnet.Template</RepositoryUrl>
    <PackageTags>Console</PackageTags>
    <PackageReadmeFile>README.md</PackageReadmeFile>
    <PackageLicenseFile>LICENSE</PackageLicenseFile>
    <Description></Description>
  </PropertyGroup>
  <PropertyGroup>
    <IncludeSymbols>true</IncludeSymbols>
    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
  </PropertyGroup>
  <ItemGroup>
    <None Include="..\..\image\logo\64x64\logo.png">
      <Pack>True</Pack>
      <PackagePath>\</PackagePath>
    </None>
    <None Include="..\..\README.md">
      <Pack>True</Pack>
      <PackagePath>\</PackagePath>
    </None>
    <None Include="..\..\LICENSE">
      <Pack>True</Pack>
      <PackagePath>\</PackagePath>
    </None>
  </ItemGroup>

Features

Getting Started

Prerequisites

• Dotnet 9.0 or later

Installation

NuGet Package

dotnet add package NugetPackageName

Clone the repo

git clone git@github.com:TirsvadCLI/Dotnet.Template.git

Usage

Notes

Example of code

See example here

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Bug / Issue Reporting

If you encounter a bug or have an issue to report, please follow these steps:

1. Go to the Issues Page
   Navigate to the GitHub Issues page.

2. Click "New Issue"
   Click the green "New Issue" button to create a new issue.

3. Provide Details

• Title: Write a concise and descriptive title for the issue.
• Description: Include the following details:
  • Steps to reproduce the issue.
  • Expected behavior.
  • Actual behavior.
  • Environment details (e.g., OS, .NET version, etc.).
• Attachments: Add screenshots, logs, or any other relevant files if applicable.

4. Submit the Issue
   Once all details are filled in, click "Submit new issue" to report it.

License

Distributed under the GPL-3.0 License.

Contact

Jens Tirsvad Nielsen - LinkedIn

Acknowledgments

• dotnet