From c8db55aa1bf245032474222d61192082967dd49f Mon Sep 17 00:00:00 2001 From: Alejandro Saucedo Date: Fri, 28 Aug 2020 12:06:03 +0100 Subject: [PATCH] Updated readme with documentation instrauctions --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 523c83c90..576d19333 100644 --- a/README.md +++ b/README.md @@ -196,3 +196,11 @@ We appreciate PRs and Issues. If you want to contribute try checking the "Good f * Uses xxd (or xxd.exe windows 64bit port) to convert shader spirv to header files * Uses doxygen and sphinx +##### Updating documentation + +To update the documentation will need to: +* Run the gendoxygen target in the build system +* Run the gensphynx target in the buildsystem +* Push to github pages with `make push_docs_to_ghpages` + +