Skip to content
This repository was archived by the owner on Jul 12, 2022. It is now read-only.

Commit ff21582

Browse files
zubivanMarcBruins
authored andcommitted
Add steps to build/run from sources to the Readme (#830)
1 parent 657b942 commit ff21582

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*.sln.docstates
99

1010
# Build results
11+
artifacts/
1112
[Dd]ebug/
1213
[Dd]ebugPublic/
1314
[Rr]elease/

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,26 @@ Commands:
5757

5858
[For detailed information about the commands, please check out the wiki](https://github.com/NuKeeperDotNet/NuKeeper/wiki)
5959

60+
### How To Uninstall
61+
62+
You can uninstall the tool using the following command.
63+
64+
```console
65+
dotnet tool uninstall nukeeper --global
66+
```
67+
68+
### How To Build and Run From Source
69+
70+
You can build and package the tool using the following commands. The instructions assume that you are in the root of the repository.
71+
72+
```console
73+
dotnet pack .\NuKeeper\NuKeeper.csproj -o ".\artifacts"
74+
dotnet tool install nukeeper --global --add-source ".\artifacts"
75+
nukeeper --version
76+
```
77+
78+
> Note: On macOS and Linux, `.\NuKeeper\NuKeeper.csproj` and `.\artifacts` will need be switched to `./NuKeeper/NuKeeper.csproj` and `./artifacts` to accommodate for the different slash directions.
79+
6080
### Licensing
6181

6282
NuKeeper is licensed under the [Apache License](http://opensource.org/licenses/apache.html)

0 commit comments

Comments
 (0)