X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=docs%2FREADME;h=ec1451369abbfb0aa02fb81895636f32e334dbd5;hb=905d2ce648ef8be0d920310e2594ecb86e3558bd;hp=f196a1dac5777c1011884ad10acf0fc35ce365db;hpb=b32994822964093e672d92815c13b70418d46cfd;p=hub.git

diff --git a/docs/README b/docs/README
index f196a1dac..ec1451369 100644
--- a/docs/README
+++ b/docs/README
@@ -1,4 +1,92 @@
 README
 ------
 
-This file needs some extending... ;)
+--------------------------------------------------------------------------------
+1.) How to launch the hub:
+--------------------------------------------------------------------------------
+
+At the current stage of code base you need to launch the hub by entering the
+following command at a command prompt (Win32) or console (Linux, etc.) in the
+root directory:
+
+php index.php app=hub
+
+Another other (later added) parameters should be added after app=hub in the same
+way due to the "design" of the inc/includes.php script. This file is somewhat
+deprecated anyway.
+
+If you want to try out an other 'node mode' just add a parameter 'mode=???' to
+the above command by '???' can be one of the following:
+
+mode=regular  -  The default mode for joining the hub network as a regular node.
+                 This mode doesn't have to be entered manually unless you
+                 changed the configuration entry in application/hub/config.php
+
+mode=boot     -  Your node acts as a bootstrapping-node. This mode is completely
+                 the same as the master-mode. If you can make sure that your node
+                 is up at least 99%, every downtime of a bootstrapping-node
+                 'hurts' the network, and that you have the latest SVN changes
+                 you might want to contact me with your static IP number and port
+                 number of your node so I may add it to the hard-coded list of
+                 boostrapping-nodes.
+
+mode=list     -  Your node participates as a list-node in the network which
+                 'aids' the master-nodes by maintaining an identical list of
+                 nodes.
+
+mode=master   -  A master-node holds a list of known nodes and which types of
+                 objects they are sharing.
+
+--------------------------------------------------------------------------------
+2.) Current development notices:
+--------------------------------------------------------------------------------
+
+These modes are currently not yet finished. If you try an invalid out you get a
+nice small error message. Still this script lacks of a 'help' command-line
+parameter and many more. This should be done with a nice helper class and not
+just 'hey, my code runs' code.
+
+--------------------------------------------------------------------------------
+3.) Why the name "hub"
+--------------------------------------------------------------------------------
+
+This software is simply called "hub". This has a simple reason that this is,
+first, the "working title" for it. And second, I have found no better name than
+"Generic Object Sharing Hub" for this. I would not shortcut it to "Gosh" or
+"GNU Gosh" or such other title, because the word "gosh" is english and
+completely misleading.
+
+So if you have a really good ("selling") name, please send it to me:
+roland[at]mxchange[dot]org or webmaster[at]ship-simu[dot]org if you prefer
+webmaster accounts... ;-)
+
+--------------------------------------------------------------------------------
+4.) How to start the cruncher
+--------------------------------------------------------------------------------
+
+The cruncher is a test application (or mayber later used in a serious
+environment?) to find the right key for an encrypted message to decrypt it. It
+can be launched with this command:
+
+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.