diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2014-08-13 14:14:49 +0200 |
|---|---|---|
| committer | Milian Wolff <milian.wolff@kdab.com> | 2014-08-13 14:43:24 +0200 |
| commit | 62760f579b52fbd19d85d31fa90274f9b0dc5111 (patch) | |
| tree | cb348241c606632ad9dbc575e28910e9302a2cc5 /examples/webchannel/nodejs/README | |
| parent | 150fba9166d0cd63079d8ed15af5f80a759e9549 (diff) | |
| download | qtwebchannel-62760f579b52fbd19d85d31fa90274f9b0dc5111.tar.gz | |
Doc: Fix example documentation and paths
To fix issues related to example documentation and to follow Qt
convention, do the following changes:
- Rename examples/qwebchannel to examples/webchannel
- Move example-specific documentation to correct location(s)
- Include generic 'Running the Example' instructions
- Add the module name to example title, fix links
This ensures that example docs are built and the example manifest
file generated correctly.
Change-Id: I284e0b13db95a6738d72258735018b59156cc7da
Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
Diffstat (limited to 'examples/webchannel/nodejs/README')
| -rw-r--r-- | examples/webchannel/nodejs/README | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/examples/webchannel/nodejs/README b/examples/webchannel/nodejs/README new file mode 100644 index 0000000..07f8fd8 --- /dev/null +++ b/examples/webchannel/nodejs/README @@ -0,0 +1,14 @@ +This is a small NodeJS implementation on how to connect to a QWebChannel. + +This example implements a small chat client using the command line. It connects +to the server provided by the other example 'examples/standalone/standalone'. Of +course the port the server listens on must be known. + +How to run it: + +- Install NodeJS (at least 0.10.x) (http://www.nodejs.org/download/) +- go to examples/nodejs and execute "npm install". This sets up the nodeJS + environment in this folder +- ensure examples/standalone/standalone is running +- execute the example with "node chatclient.js" + |