(JEC) 8/5/15 add install target in Makefile and comments in README.md

Makefile

@@ -30,13 +30,15 @@ LIB = ./lib/
 OBJ = ./objs/
 EXE = ./bin/
 DATA = ./data/
+INCL = ./include/LagSHT/
 
 #  Define our target list
 .PHONY: default
 default: makedir lib lagsht_testsuite
 
 .PHONY: all 
-all : makedir lib lagsht_testsuite
+all : makedir lib lagsht_testsuite 
+
 
 .PHONY: check
 check : makedir lagsht_testsuite
@@ -89,6 +91,11 @@ CXXHDR = $(SRC)lagsht_exceptions.h \
 
 
 
+.PHONY: install
+install:
+	mkdir -p $(INCL)
+	cp $(SRC)/*.h $(INCL)
+
 CPPFLAGS  += $(BLASYES) $(SHARPINC) $(BLASINC)
 LDFLAGS   += $(SHARPLIBN) $(BLASLIBN)  -lm
 

README.md

@@ -11,16 +11,21 @@ git clone https://gitlab.in2p3.fr/campagne/LagSHT.git
 
 	
 # List of files
-* laguerreBuilder.h (.cc) : class of generalized Laguerre function * laguerreTransform.h (.cc) : class to manage the Laguerre function Transform (Synthesis & Analysis): Single or Multiple  
-* lagSphericTransform.h (.cc) : class to manage the Spherical Harmonic & Laguerre function Trnasform (Synthesis & Analysis). Choice of different geometry for the Sphere pixelizations.
-* lagsht_execptions.h: class derived from std::exceptions.
-* walltimer.h (.cc): utilities to profile the program.
-* lagsht_utils.h: code by David Robert Nadeau to get the avalable memory
-* lagsht_spheregeom.h (.cc) : set of classes to deeal with the 2D sphere pixelization and libsharp initialization
-* lagsht_geom.h : define some typedef used in the code for geometry
-* lagsht_testsuite.c : a simple program to test different piece of the code
-* Makefile that should be tuned to the local platform (*.inc files)
-* doxydoc / footer.html : input file to doxygen tool to generate the class documentation 
+* **src** directory
+	* laguerreBuilder.h (.cc) : class of generalized Laguerre function 
+	* laguerreTransform.h (.cc) : class to manage the Laguerre function Transform (Synthesis & Analysis): Single or Multiple  
+	* lagSphericTransform.h (.cc) : class to manage the Spherical Harmonic & Laguerre function Trnasform (Synthesis & Analysis). Choice of different geometry for the Sphere pixelizations.
+	* lagsht_execptions.h: class derived from std::exceptions.
+	* walltimer.h (.cc): utilities to profile the program.
+	* lagsht_utils.h: code by David Robert Nadeau to get the avalable memory
+	* lagsht_spheregeom.h (.cc) : set of classes to deeal with the 2D sphere pixelization and libsharp initialization
+	* lagsht_geom.h : define some typedef used in the code for geometry
+	* lagsht_testsuite.c : a simple program to test different piece of the code
+* **root** directiry 
+	* Makefile that should be tuned to the local platform (*.inc files)
+* **doc** directiry 
+	* doxydoc : input file to `doxygen` tool to generate the class documentation 
+* **bin**/**lib** directories are the location of executable and library while **include** is the location of LagSHT/*.h files.
 
 # Required Librairy
 
@@ -62,7 +67,14 @@ The result of "make" is binanry file under ./Objs directory as well as `lagsht.a
  		 Numerical Error estimate.
  	> make fullcheck 
  		runs a series of `lagsht_testsuite` which activates different parts of the code and shows how-to call this test program.
- 		  
+ 	> make install
+ 		install the <src>/headers files to  <root>/include/LagSHT 
+ 		then one should use -I<root>/include/LagSHT in their makefile. 
+ 		If one wants a different location then look at INCL variable 
+ 		in the Makefile. 
+ 		Similarly, the library is in <root>/lib but one can switch to 
+ 		another location by modifying the LIB variable in the 
+ 		Makefile.	  
 # Plateform tested
 	Mac OS X 10.9.5 + gcc 4.8.4
 	Linux SLC 6.6   + gcc 4.9.1 20140922