[ds6-devel] nc6 README.Maint,1.3,1.4

[chris@deepspace6.net]

Update of /cvs/nc6

Modified Files:
	README.Maint 
Log Message:
Added a section on development principles and objectives.  I'm a fan of
defining this sort of thing - makes it easier later when decisions have to
be made.
Mauro - please review these as I'm just guessing what would be good and you,
obviously, have final say.


Index: README.Maint
===================================================================
RCS file: /cvs/nc6/README.Maint,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- README.Maint	29 Dec 2002 14:12:10 -0000	1.3
+++ README.Maint	1 Jan 2003 21:15:50 -0000	1.4
@@ -24,6 +24,35 @@
 script.
 
 
+Development Objectives and Principles
+-------------------------------------
+
+The objectives for the development of netcat6 are:
+  * To produce a functional replacement of netcat with complete AF
+     independence (especially support for IPv6).
+  * To provide the functions of netcat that are useful without the features
+     that are unnecessary or where a better method exists.
+  * To provide additional functionality that would be useful in this type
+     of application.
+  * Clear and well structured code and documentation.  netcat6 should serve as
+     an excellent example of AF independant network programming.
+  * To be highly portable (to many platforms and operating systems) as long
+     as the code can remain clear and well structred.
+
+The following are NOT objectives for netcat6 development:
+  * Complete compatability with the original netcat.
+
+The following are the principles for netcat6:
+  * Open design: The design should not be secret (nc6 is GPL, so both design
+     and implementation are public).
+  * Economy of mechanism: Keep the design as simple as possible.
+  * Least astonishment: The application behavior should match what is
+   naively expected.
+  * Simplicity of function: The application should perform functions that are
+     useful in the context of general use of the application (eg. it should 
+     not become bloated with oft unnecessary features).
+
+
 Style guide
 -----------