OSCAR-code

mirror of https://gitlab.com/pholy/OSCAR-code.git synced 2025-04-08 12:10:43 +00:00

History

Mark Watkins edb7bc3690 Moving Quazip and QExtSerialPort to external libraries for mac and unix		2013-10-10 01:42:46 +10:00
..
examples	Moving Quazip and QExtSerialPort to external libraries for mac and unix	2013-10-10 01:42:46 +10:00
style	Moving Quazip and QExtSerialPort to external libraries for mac and unix	2013-10-10 01:42:46 +10:00
doc.pri	Moving Quazip and QExtSerialPort to external libraries for mac and unix	2013-10-10 01:42:46 +10:00
index.qdoc	Putting things back	2013-09-16 14:45:50 +10:00
qextserialport.qdocconf	Moving Quazip and QExtSerialPort to external libraries for mac and unix	2013-10-10 01:42:46 +10:00
readme.txt	Putting things back	2013-09-16 14:45:50 +10:00

readme.txt

Note: 

  If you are using qextserialport-XXX.tar.gz, the qesp.qch and
  html files have been provided.

  Open the file "html/index.html" using your web browser.
  Or integrated the "html/qesp.qch" into your QtCreator.


== How to generate help files? ==

Simply run following commands at toplevel directory.
    qmake
    make docs

Or run the following command at this directory
    qdoc3 qextserialport.qdocconf

Then a folder called "html" will be generated. 
Open the file "html/index.html" using your web browser.

== How to integrated into Qt Creator or Qt Assistant? ==

Once the html files are generated. run following commands
   cd doc/html
   qhelpgenerator qesp.qhp

A file called "qesp.qch" will be generated.

For Qt Assistant: 
   Edit ==> Preferences ==>  Documentations ==> Add...

For Qt Creator
   Tools ==> Options ==> Help ==> Documentations ==> Add...