From c36eb6186e82fabaf968df46c1992e7c5d5596ac Mon Sep 17 00:00:00 2001 From: Charlie Kindel Date: Thu, 22 Oct 2020 09:57:02 -0600 Subject: [PATCH] docfx readme updates --- docfx/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docfx/README.md b/docfx/README.md index 0cc994d6a..42477bcd9 100644 --- a/docfx/README.md +++ b/docfx/README.md @@ -1,4 +1,6 @@ -This folder generates the API docs for Terminal.Gui +This folder generates the API docs for Terminal.Gui. + +The API documentation is generated using the [DocFX tool](https://github.com/dotnet/docfx). The output of docfx gets put into the `./docs` folder which is then checked in. The `./docs` folder is then picked up by Github Pages and published to Miguel's Github Pages (https://migueldeicaza.github.io/gui.cs/). ## To Generate the Docs