From bf026f6d7db3e550e17418325ddfc84659315cca Mon Sep 17 00:00:00 2001 From: Atul R Date: Tue, 9 Jun 2020 21:40:27 +0200 Subject: [PATCH] update docs instructions --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 597e5af7a..b6d121fd6 100644 --- a/README.md +++ b/README.md @@ -127,9 +127,17 @@ Please read https://github.com/nodegui/.github/blob/master/CONTRIBUTING.md Optionally set `QT_INSTALL_DIR='/path/to/qt'` environment variable to build using your own version of Qt. +## Updating docs + +`npm run docs` + +then followed by: + +`cd website && GIT_USER= yarn deploy` + ## Funding -NodeGUI is an open source project and requires your support. If you like this project, please consider supporting my work by clicking on the Sponsor button on this Github repository or via Ko-Fi. +NodeGui is an open source project and requires your support. If you like this project, please consider supporting my work by clicking on the Sponsor button on this Github repository or via Ko-Fi. Alternatively, Issues on NodeGui can be funded by anyone via Issuehunt and the amount will be distributed to respective contributors.