summaryrefslogtreecommitdiffstats
path: root/src/assistant/tools/assistant/doc/HOWTO
diff options
context:
space:
mode:
Diffstat (limited to 'src/assistant/tools/assistant/doc/HOWTO')
-rw-r--r--src/assistant/tools/assistant/doc/HOWTO16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/assistant/tools/assistant/doc/HOWTO b/src/assistant/tools/assistant/doc/HOWTO
new file mode 100644
index 000000000..a0143479e
--- /dev/null
+++ b/src/assistant/tools/assistant/doc/HOWTO
@@ -0,0 +1,16 @@
+How to build/ update a new assistant.qch for Assistant internal help
+
+- update:
+ - open assistant.qdocconf, update year and qt version
+
+ - ..\..\..\..\qdoc3\debug\qdoc3.exe assistant.qdocconf
+ will generate an folder html containing all required stuff
+
+ - cp assistant.qhp to generated html folder
+ - run qhelpgenerator html\assistant.qhp -o ..\assistant.qch
+
+ - rebuild assistant
+
+- to test your changes:
+ - remove assistant.qch in your cache directory
+ - restart assistant