Finally fixed???

[hub.git] / docs / README

diff --git a/docs/README b/docs/README
index fbc1067586de2fe2697d5179dd63f75e76380e7b..33a874b5ecdb85cd2526efc63c767c7035260442 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -53,9 +53,74 @@ just 'hey, my code runs' code.
 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
+"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 maybe 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 miner
+--------------------------------------------------------------------------------
+
+The miner is a test application (or maybe later used in a serious
+environment?) to find hash blocks:
+
+php index.php app=hub command=miner
+
+--------------------------------------------------------------------------------
+6.) How to start the crawler
+--------------------------------------------------------------------------------
+
+The distributed crawler is a test application (or maybe later used in a serious
+environment?) to crawl websites and build a searchable and distributed index:
+
+php index.php app=hub command=crawler
+
+--------------------------------------------------------------------------------
+7.) 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.
+
+--------------------------------------------------------------------------------
+8.) 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