X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=docs%2FREADME;h=b54b6ea59e7682f8100aae056ed6ac8938f306f7;hb=0061ab4550d54cb28adaa8b672ccd57ba996fc76;hp=8639c614ecca1895fc220168c988428dfe8749b7;hpb=83a9b3ff0dd30fa092c059ed8496a7c81ade3dd0;p=hub.git

diff --git a/docs/README b/docs/README
index 8639c614e..b54b6ea59 100644
--- a/docs/README
+++ b/docs/README
@@ -6,17 +6,17 @@ README
 --------------------------------------------------------------------------------
 
 At the current stage of code base you need to launch the hub by entering the
-following command at at command prompt (Win32) or console (Linux etc.) in the
-root directory of this script:
+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. We need to change that
-anyway.
+way due to the "design" of the inc/includes.php script. This file is somewhat
+deprecated anyway.
 
-If you want to e.g. temporarily try out an other 'node mode' just add a parameter
-'mode=???' to the above command by '???' can be one of the following:
+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
@@ -41,6 +41,68 @@ mode=master   -  A master-node holds a list of known nodes and which types of
 2.) Current development notices:
 --------------------------------------------------------------------------------
 
-These modes are currently not yet finished. If you try an invalid out you may
-get an exception called 'ClassNotFoundException' which has to be rewritten to
-test if the mode is valid and output a nicer message to the user.
+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.
+
+--------------------------------------------------------------------------------
+6.) How to start the apt-proxy and use it
+--------------------------------------------------------------------------------
+
+The apt-proxy is yet another test application for the node and shall provide a
+proxy for sharing Debian packages over the node network. You can launch its
+connector by invoking this command:
+
+php index.php app=hub command=apt-proxy
+
+If you do so, another port xxxxx will be opened which you can use in your deb
+and deb-src lines:
+
+deb [arch=amd64,i386] http://localhost:xxxxx/ftp.de.debian.org/debian unstable main non-free contrib
+deb-src [arch=amd64,i386] http://localhost:xxxxx/ftp.de.debian.org/debian unstable main non-free contrib