From 50b0c45cfb1fcddc63ead69e0d002be537c78760 Mon Sep 17 00:00:00 2001
From: Alexandros Kritikos <akritikos@outlook.com>
Date: Wed, 19 Mar 2025 02:16:38 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Adds=20basic=20guidelines=20in?=
 =?UTF-8?q?=20using=20this=20template?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ff171c2
--- /dev/null
+++ b/README.md
@@ -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