📝 Adds basic guidelines in using this template

This commit is contained in:
Alexandros Kritikos 2025-03-19 02:16:38 +02:00
parent 50e2e1d642
commit 50b0c45cfb
No known key found for this signature in database
GPG Key ID: D68ED042B18F1740

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# Templates - Dotnet
A starting point for new .NET projects, based on opinionated rules.
1. In order to be able to update your repository with the latest changes, you can use the following command **after creating** your repo:
```bash
git remote add template https://github.com/kritikos-io/templates-dotnet
git fetch --all
git merge template/main --allow-unrelated-histories
```
2. Do this as soon as possible, as the unrelated histories flag will lead to a few conflicts that you will need to resolve manually.
3. Afterward, you can pull changes using
```bash
git pull template main
```
4. Rename the solution and project files, replacing 'Sample' to match your project name.
1. Sample.sln
2. Sample.sln.DotSettings
3. Sample.code-workspace
> Keep in mind that until the dotnet toolset handles generating new projects correctly, you will need to edit new csproj files and remove Version attributes from PackageReference entries. For more details consult [Central Package Management].
[Central Package Management]: https://learn.microsoft.com/en-us/nuget/consume-packages/central-package-management