Documentation update

Author: brichards64

DataModel/README.md

@@ -1 +1,8 @@
-# DAQFramework
+#Data Model
+*************************
+
+Data Model Class can be defined how ever the User requires. A Store is provided which ineficently maps variables to string lkeys via conversion to stringstream and can be used for debuging or other useful vairables.
+
+A TTree map with getter and setter functions is provided and can be uncommented if required.
+
+ 

README.md

@@ -1,14 +1,14 @@
 # DAQFramework
 
 ****************************
-#Consept
+#Concept
 ****************************
 
 The main executable creates a ToolChain which is an object that holds Tools. Tools are added to the ToolChain and then the ToolChain can be told to Initialise Execute and Finalise each tool in the chain.
 
-The ToolChain also holds a uesr defined DataModel which each tool ahs access too and can read ,update and modify. This is the method by which data is passed between Tools.
+The ToolChain also holds a uesr defined DataModel which each tool has access too and can read ,update and modify. This is the method by which data is passed between Tools.
 
-User Tools can be generated for use in the tool chain by incuding a Tool header.This can be done manually or by use of the newTool.sh script.
+User Tools can be generated for use in the tool chain by incuding a Tool header. This can be done manually or by use of the newTool.sh script.
 
 For more information consult the README files in the relavent directories
 
@@ -37,4 +37,4 @@ To adapt for your own uses you need to:
  Create user tools : see README in UserTools/
  Modify data model : see README in DataModel/
  Modify main : see README in src/ 
- Modify Makefile : For simple applications the only modification needed is to populate the variables for your data model and user tool dependancies.  	
+ Modify Makefile : For simple applications the only modification needed is to populate the variables for your data model and user tool dependancies.  	

configfiles/README.md

@@ -1 +1,25 @@
-# DAQFramework
+# Configure files
+
+***********************
+#Description
+**********************
+
+Configure files are simple text files for passing variables to the Tools.
+
+Text files are read by the Store class (src/Store) and automatically asigned to an internal map for the relavent Tool to use.
+
+
+************************
+#Useage
+************************
+
+Any line starting with a "#" will be ignored by the Store, as will blank lines.
+
+Variables should be stored one per line as follows:
+
+
+Name Value #Comments 
+
+
+Note: Only one value is permitted per name and they are stored in a string stream and templated cast back to the type given.
+

src/README.md

@@ -1 +1,61 @@
-# DAQFramework
+# SRC Directory
+**************************
+
+
+Source directory contains the main.cpp and mager framework code incuding:
+
+
+The virtual Tool.h headder that Usertools should inherit from in order to work in the tool chain.
+
+The ToolChain code for controlling and storing Tools
+
+The Store code for inefficent mapped variable store used in  configuration file readin.
+
+The Socket comunication class (work in progress)
+
+
+
+***********************
+Main.cpp Description
+***********************
+
+The main.cpp needs to be endited by the user in order to inculde the necessary tools for use in the DAQ. The current example code loads 1 tool known as DummyTool and then executes the functions Initialise Execute and Finalise on each tool sequenctially. 
+
+Code Description:
+
+     1) All UserTools that are required in the frame work need their individual headers included along with the ToolChain.h at tthe start of the code
+
+     	    #include "ToolChain.h"
+    	    #include "DummyTool.h"
+
+    	    int main(){
+
+
+     2) Each tool and the toolchain need to then be instansiated 
+
+
+     	      ToolChain tools;
+  	      DummyTool dummytool;
+
+     3) The Tools must then be added to the tool chain one by one in order. Three arguments can be provided when adding the tool (1)tool name in the tool chain, (2) pointer to the tool, (3) conifguration file [optional] .
+
+     	      tools.Add("DummyTool",&dummytool,"configfiles/DummyToolConfig");
+
+
+      4) The ToolChain will will Initialise, then Execute and Finalise each tool in the chain in the order they have been added. The execution of this chain can be done in three ways.
+
+      	     	       1) Precompiles execution (shown in main.cpp)
+		       	  	      
+				       tools.Initialise();
+				       tools.Execute();
+				       tools.Finalise();
+
+		       2) Interactive execution. Initialise execute and finalise can be run via command line as well as start, stop, pause, unpause, and quit.
+
+		       	  	      tools.Interactive();
+
+		       3) Remote execution. Toolchain commands like interactive and can be passed between processes or computers via TCP.
+
+					tools.Remote(portnum);
+
+