Skip to content

Commit 629f5d0

Browse files
committed
Update documentation for build to fix #76
1 parent acd9976 commit 629f5d0

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

ReadMe.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,18 @@ We have a few modules which are required for building. They're listed in `Requir
4040

4141
#### 3. Run the `build.ps1` script.
4242

43+
By default, the build script uses [gitversion](/gittols/gitversion) to calculate the version of the build automatically:
44+
4345
```powershell
4446
.\build.ps1
4547
```
4648

49+
If you don't have gitversion handy, you can just specify a version for the `-Semver` parameter:
50+
51+
```powershell
52+
.\build.ps1 -Semver 2.0.0-beta
53+
```
54+
4755
#### 4. Make the compiled module available to Powershell
4856

4957
The `.\build.ps1` process will output the path to the folder named with the current version number, like "1.0.0" -- the compiled psm1 and psd1 files are in that folder. In order for PowerShell to find them when you ask it to import, they need to be in the PSModulePath. PowerShell expects to find modules in a folder with a matching name that sits in one of the folders in your PSModulePath.

0 commit comments

Comments
 (0)