-
Notifications
You must be signed in to change notification settings - Fork 9
10. Building From Source
James231 edited this page Jun 9, 2020
·
3 revisions
Follow these steps to build the tool from source:
- Install the .NET Core SDK (3.1 or later). If you are on Windows, then installing Visual Studio 2019 with the .NET Core Workload will install the latest version.
- Clone the repository with:
git clone https://github.com/James231/Documentation-Templater.git
- Open a terminal to the
src/DocumentationTemplater
directory. - Enter the command following command to build a single file excutable from the project. In the command replace
win10-x64
with your target platform (see list here):
dotnet publish -r win10-x64 -c Release -p:PublishSingleFile=true --self-contained false
Change to--self-contained true
if you do not want to bundle the .NET Core runtime in the executable. The file this produces will be in thebin/Release/netcoreapp3.1
folder. - Copy the executable into the
sample
directory (alongsideInput
andTemplate
folders) and run it to generate a documentation in theOutput
folder.
Enjoying using Documentation Templater? Make sure you ⭐ the repo!!!