]> git.mxchange.org Git - hub.git/commitdiff
Documentation section added for 'chat console'
authorRoland Häder <roland@mxchange.org>
Thu, 26 May 2011 04:18:58 +0000 (04:18 +0000)
committerRoland Häder <roland@mxchange.org>
Thu, 26 May 2011 04:18:58 +0000 (04:18 +0000)
docs/README

index 71b3873579669a0acf32979d55d925de921f4c8b..ec1451369abbfb0aa02fb81895636f32e334dbd5 100644 (file)
@@ -73,3 +73,20 @@ php index.php app=hub command=cruncher
 A producer application will follow which shall produce work units for the
 cruncher to work on. In the meanwhile the cruncher shall run test units which
 I will mainly use for development.
+
+--------------------------------------------------------------------------------
+5.) How to start the chat console and use it
+--------------------------------------------------------------------------------
+
+The chat console is yet another test application for the node. You can launch
+its "server-side" part by invoking this command:
+
+php index.php app=hub command=chat
+
+If you do so, another port xxxxx will be opened where you can telnet to:
+
+telnet localhost xxxxx
+
+After that you will be greeted and you are able to enter simple commands. Please
+do not try any 'interactive console' things like cursor key or so. This is
+(or will be) a very simple and basic telnet console.