aboutsummaryrefslogtreecommitdiffstats
path: root/examples/serialport/terminal/doc/terminal.rst
diff options
context:
space:
mode:
Diffstat (limited to 'examples/serialport/terminal/doc/terminal.rst')
-rw-r--r--examples/serialport/terminal/doc/terminal.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/examples/serialport/terminal/doc/terminal.rst b/examples/serialport/terminal/doc/terminal.rst
new file mode 100644
index 000000000..61579121f
--- /dev/null
+++ b/examples/serialport/terminal/doc/terminal.rst
@@ -0,0 +1,9 @@
+Terminal Example
+================
+
+The Terminal Example shows how to create a terminal for a simple serial
+interface by using Qt Serial Port.
+
+It demonstrates the main features of the QSerialPort class, like configuration,
+I/O implementation and so forth. Also, the class QSerialPortInfo is invoked to
+display information about the serial ports available in the system.