improve README.md

README

@@ -1,29 +0,0 @@
-Actually this is some kind of server toolkit, also containing
-a class and interface toolkit for C.
-I use a gcc preprocessor extension to use empty variadoc
-argument lists so actually this is gcc only code.
-
-This should become a server that has a dynamic time-sliced part
-that updates an internal state all the time.
-Clients might connect as they want and get some information
-from the server.
-The server should scale in two manners.
-New instances should be able to handle connection and get
-updates about the computed state.
-Additionally new instances might hold their own state which
-all other instances might update.
-
-In a first run the state might be something simple as a 
-matrix where every field hold a unique value. e.g.
-
- -------------
- |1|4|a|j|k|9|
- -------------
- |1|4|a|j|k|9|
- -------------
- |1|4|a|j|k|9|
- -------------
- |1|4|a|j|k|9|
- -------------
-
-suggestion for timing: sigsuspend

README.md

@@ -1,10 +1,63 @@
 # server
 
-## abstract
+One early server code.
 
-Another abandoned server code base... this is kind of an ancestor of
-taskrambler.
+## Synopsis
 
-## state
+[unknown]
 
-discontinued
+## Description
+
+Actually this is some kind of server toolkit, also containing
+a class and interface toolkit for C.
+I use a gcc preprocessor extension to use empty variadoc
+argument lists so actually this is gcc only code.
+
+This should become a server that has a dynamic time-sliced part
+that updates an internal state all the time.
+Clients might connect as they want and get some information
+from the server.
+The server should scale in two manners.
+New instances should be able to handle connection and get
+updates about the computed state.
+Additionally new instances might hold their own state which
+all other instances might update.
+
+In a first run the state might be something simple as a
+matrix where every field hold a unique value. e.g.
+
+ | | | | |
+-|-|-|-|-|-
+1|4|a|j|k|9
+1|4|a|j|k|9
+1|4|a|j|k|9
+1|4|a|j|k|9
+
+suggestion for timing: sigsuspend
+
+## Requirements
+
+ * Gnu C
+
+## Contributing
+
+Just email me.
+
+## License
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+    
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+    
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+## Author
+
+Georg Hopp <georg@steffers.org>