From 08b0461f2ef85e4b03d905128e4dcc5b3bf849fe Mon Sep 17 00:00:00 2001 From: Alexandros Kritikos Date: Sat, 30 Nov 2019 20:10:56 +0200 Subject: [PATCH] :pencil: Adds documentation --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..76d424d --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# Templates - Dotnet + +A simple template leveraging [.Config][1] dotfiles submodule for rapid project deployment. Simply rename Solution.{code-workspace,sln,sln.DotSettings} to your project name and get started! Afterwards, replace this readme with the actual documentation of your project. + +Additionally, until GitHub properly supports submodule definitions from template repositories, after cloning you should run +```git submodule add https://github.com/kritikos-io/.config``` from the repository root. You can replace the submodule with a compatible fork (to preserve your own default namespace etc) **provided it keeps file naming intact** since most files are appearing as symlinks. + +[1]: https://github.com/kritikos-io/.config