Skip to content

Commit 40d61c6

Browse files
committed
Updated README
1 parent 400d012 commit 40d61c6

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,5 @@ launchSettings.json
4242
.idea/workspace.xml
4343
/eng/tools
4444
*.Import.props
45-
*.g.props
45+
*.g.props
46+
*.log

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,16 @@
22

33
This repo is a template for new repos that are built using `PostSharp.Engineering`.
44

5-
For instructions, see https://github.com/postsharp/PostSharp.Engineering.
5+
This repo assumes it builds a product named `My.Product`. A _product_, in the context of PostSharp.Engineering, is essentially synonym to a repo, and it can produce several deployable artifacts, typically several NuGet packages. All artifacts in the same product have the same version and build number.
6+
7+
After cloning the repo, you should do this:
8+
9+
* Use `Build.ps1 tools git rename` to rename `My.Product` into your product name, _with_ dots.
10+
* Use Visual Studio Code find-and-replace all to rename:
11+
* `My.Product` into your product name _with_ dots,
12+
* `MyProduct` into your product name _without_ dots.
13+
14+
The build entry point is `Build.ps1`.
15+
16+
For more instructions, see https://github.com/postsharp/PostSharp.Engineering.
17+

0 commit comments

Comments
 (0)