From 15f9e03e27915234ed7f95e8afa1e139ec5d86d5 Mon Sep 17 00:00:00 2001 From: SchlenkR Date: Sun, 16 Jan 2022 11:05:39 +0100 Subject: [PATCH] #72: Fixed wrong explanation of how to build the documentation --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index aa0c1ade..3c430738 100644 --- a/README.md +++ b/README.md @@ -47,20 +47,23 @@ Building You need to have the latest .Net 5 SDK installed. +### Building binaries, publish, and test + There is a F# script that can be used to perform several build tasks from command line. It can be executed in this way: -`dotnet fsi .\build.fsx [task]` +`PS> dotnet fsi .\build.fsx [task]` Common tasks are: * build * test -* docu * publish -### Building Readme.md +### Building the documentation + +The documentation in `./docs` is auto-generated from the files in `./src/Docu`. In order to build them, run: -The `Readme.md` and the content in `./docs` is auto-generated from the files in `./src/Docu`. In order to build them, run the command `dotnet fsi .\build.fsx docu`. +`PS> .\docu.ps1` Credits