From 47961e9d665f5b627c1abbabe35fd3860d80e42f Mon Sep 17 00:00:00 2001
From: adrien-matta <a.matta@surrey.ac.uk>
Date: Mon, 20 Oct 2014 12:08:39 +0100
Subject: [PATCH] * Editing the README.md file

---
 NPAnalysis/Example1/Makefile |  4 ++--
 README.md                    | 42 +++++++++++++++++++++++++++++++-----
 2 files changed, 39 insertions(+), 7 deletions(-)

diff --git a/NPAnalysis/Example1/Makefile b/NPAnalysis/Example1/Makefile
index 702853b4c..abdac126f 100755
--- a/NPAnalysis/Example1/Makefile
+++ b/NPAnalysis/Example1/Makefile
@@ -6,11 +6,11 @@ include $(NPLIB)/Makefile.arch
 LIBRARY  = `$(NPLIB)/liblist`
 LIBRARY += -L$(CLHEP_LIB_DIR) -l$(CLHEP_LIB)
 
-PROGRAMS	= Analysis
+PROGRAMS	= NPAnalysis
 
 all:	$(PROGRAMS)
 
-Analysis:	Analysis.o
+NPAnalysis:	Analysis.o
 	$(LD) $(LDFLAGS) $^ $(LIBS) $(LIBRARY) $(OutPutOpt) $@
 	@echo "$@ done"
 	
diff --git a/README.md b/README.md
index 1c826c2cd..dbb3bd396 100644
--- a/README.md
+++ b/README.md
@@ -32,21 +32,25 @@ and you should be in the NPLib directory.
 Before the compilation of the libraries you need to specify the detector you plan to use by calling the configure script. If you give no argument to configure, all detector will be compile. If you wish to limit the number of detector to be compiled, simply specify the detector name in lowercase (e.g. MUST2 -> must2). You can specify more than one detector:
 
 ````
-$ ./configure must2 sharc plastic riken
+$ ./configure
+````
+OR:
+````
+$ ./configure detectorname1 detectorname2 ... detectornameN
 ````
 
-You have to performe the configure operation only once, then you compile the whole NPLib with:
+You have to performe the configure operation only once, then you compile the whole NPLib with n threads using :
 
 ````
 $ make -jn
 ````
 
-where you replace n is the number of core to be used in the compilation.
+NB: Optimal compilation time is usually achieved for n = twice the number of available core.
 
 If you wish to compile only one subdirectory, simply add the name of the directory in lower case, e.g. for compiling the Physics directory:
 
 ````
-$ make -jn physics
+$ make physics
 ````
 
 In order to load the nptool libraries when you launch root, you need to add a few line to your ~/.rootlogon.C file. NPTool can do that safely for you using a script. To launch the script simply type:
@@ -61,10 +65,38 @@ This part of the package rely on Geant4 to perform Monte Carlo simulation. You n
 $ NPS
 $ make -jn
 `````
-This should produce the NPSimulation executable, you can check this by running the help display
+
+This will produce the NPSimulation executable. For a detail list of the available input flag and their meaning, you can run:
 ````
 $ NPSimulation -h
 ````
 
+To run a standardise test case, you can run the following command:
+````
+$ NPSimulation -D Example1.detector -E Example1.reaction -O Example1
+````
+This will open the NPSimulation GUI (if you are using Qt) or the prompt terminal. In either case you can generate event using:
+
+````
+> run/beamOn/ 10000
+> exit
+````
+
+This will run the 11Li(d,3He)10He->8He+n+n simulation and produce a root file located in $NPTOOL/Outputs/Simulation/Example1.root.
+
+You can now try to analyse this simulated tree using the associated NPAnalysis project:
+````
+$ NPA
+$ cd Example1/
+$ make
+$ ./NPAnalysis -D Example1.detector -R RunToTreat.txt -O Example1
+````
+
+This will produce the analysed tree located in $NPTOOL/Outputs/Analysis/Example1.root. You can display the result of the simulation using root:
+````
+$ root ShowResult.C
+````
 
+You should be able to see the light particle identification, the light particle kinematical line and the associated excitation nergy spectrum.
+ 
 THIS FILE IS UNDER DEVELOPMENT
-- 
GitLab