Skip to content

Commit 5d9d33d

Browse files
authored
Improve build instructions (#948)
1 parent df5a5b7 commit 5d9d33d

File tree

1 file changed

+60
-9
lines changed

1 file changed

+60
-9
lines changed

docs/input/documentation/contributing/how-to-build.md

Lines changed: 60 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,67 @@ title: How to build addins
33
description: Instructions how to build individual Cake Issues addins.
44
---
55

6-
To build this a package we are using Cake.
6+
## Building addins
77

8-
On Windows PowerShell run:
8+
Ensure the following prerequisites are fulfilled:
99

10-
```powershell
11-
./build
12-
```
10+
* Latest .NET version installed
1311

14-
On OSX/Linux run:
12+
To build the addins and run unit tests [Cake] is used:
1513

16-
```bash
17-
./build.sh
18-
```
14+
=== ":material-microsoft-windows: Windows"
15+
16+
```powershell
17+
.\build.ps1
18+
```
19+
20+
=== ":material-apple: macOS"
21+
22+
```bash
23+
./build.sh
24+
```
25+
26+
=== ":material-linux: Linux"
27+
28+
```bash
29+
./build.sh
30+
```
31+
32+
To run only part of the build a task can be passed using the `--target=<TASK>` syntax:
33+
34+
| Task | Description |
35+
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
36+
| `DotNetCore-Build` | Builds all addins |
37+
| `Create-NuGet-Packages` | Builds an creates NuGet packages for all addins. The NuGet packages are available in the `BuildArtifacts\Packages\NuGet` directory. |
38+
| `Test` | Builds all addins and runs unit tests. Coverage report is available in the `BuildArtifacts\TestCoverage` directory. |
39+
40+
## Building and running website locally
41+
42+
Ensure the following prerequisites are fulfilled:
43+
44+
* Latest .NET version installed
45+
* Python 3 installed
46+
47+
To build and serve the website [Cake] is used:
48+
49+
=== ":material-microsoft-windows: Windows"
50+
51+
```powershell
52+
.\build.ps1 --target=website
53+
```
54+
55+
=== ":material-apple: macOS"
56+
57+
```bash
58+
./build.sh --target=website
59+
```
60+
61+
=== ":material-linux: Linux"
62+
63+
```bash
64+
./build.sh --target=website
65+
```
66+
67+
Website is available on `http://127.0.0.1:8000/`
68+
69+
[Cake]: https://cakebuild.net/

0 commit comments

Comments
 (0)