add tree layout info

2004/08/12 13:30:26-05:00 anl.gov!desai
update to current state

(Logical change 1.41)


git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@245 ce84e21b-d406-0410-9b95-82705330c041

1 files changed, 22 insertions, 4 deletions

diff --git a/README b/README
index 54c84b0c5..4a7e2d4fb 100644
--- a/README
+++ b/README
@@ -1,5 +1,23 @@
-This is the BCFG2 repo. 
+Release 0.3 - $Id: $
 
-BCFG2 is a wholesale replacement of the BCFG1 codebase. 
-This is not even software yet, it is starting as a dumping 
-ground for design documents and initial code. 
\ No newline at end of file
+This is the Bcfg2 repo. It is a configuration management system
+designed to ease the management of networks of heterogenous
+systems. The system has been completely redesigned and reimplemented
+from version 1.
+
+Currently, bcfg2 is in alpha-ish state. The server infrastructure can
+produce configurations in clients based on the a set of structures and
+generators. Generators can provide clients with probes to execute
+(guiding the configuration generation process) and recieve the data
+these probes generate. Client statistics are not currently generated. 
+
+The bcfg2 client is a lot more rough. The client works, though its
+adherence to bundle semantics is probably not what it should be. It
+successfully one-way validates configurations. Two-way support is not
+yet implemented. 
+
+The source tree is structured in the following way:
+
+doc/ - documentation
+src/  - source code
+schemas/ - schemas defining the data format for configuration files