From d499b86af3d0f7312dc1c0e15c146606056ff213 Mon Sep 17 00:00:00 2001 From: Alexandros Kritikos Date: Wed, 15 Nov 2023 18:51:33 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Adds=20current=20information=20t?= =?UTF-8?q?o=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .config | 2 +- README.md | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.config b/.config index cd2e174..8e588a3 160000 --- a/.config +++ b/.config @@ -1 +1 @@ -Subproject commit cd2e174a8756a7407a6f7d9c0da022019091a51f +Subproject commit 8e588a3712c098f3b5fef351b11dfde968120095 diff --git a/README.md b/README.md index 810361c..fb780dc 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ # 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. +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! To use: -Additionally, change the Project & Repository urls on [src/Directory.Build.props](src/Directory.Build.props). +- Make sure git symlinks are enabled in your system +- Rename Solution.sln, Solution.sln.DotSettings and Solution.code-workspace to your project name (replacing only "Solution" on the file names) +- Edit [src/Directory.Build.props](src/Directory.Build.props) and add your project site URL (or your repository, if no site available) +- Enter a terminal inside the folder you just cloned and run `git submodule update --init` -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. +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