Update README.md

README.md

@@ -0,0 +1,38 @@
+# musrSim simulation #
+
+### Contents ###
+
+This is the C++ source code for the musrSim simulation software. This software is intended to be a general tool for the whole µSR community.  To compile and run musrSim, the user has to have Geant4 and Root installed. musrSim was tested with Geant versions 4.9.5, 4.10.0 and Root version 5.32, and Geant4.10.3 with root version 6. Root version should not be critical, but Geant4 version should be 9.5, 10.0, or 10.3 for the corresponding source codes. 
+
+* This code is specifically tuned to simulate implantation of low energy projectiles in materials.
+* The code is maintained by the Low Energy Muons group at PSI. 
+* The GUI is written in Node.js, JavaScript and Electron. 
+* The binary (statically linked) from the fortran code is also included.
+* RPM and DEB packages are also included
+
+### Supported platforms ###
+
+* Linux and any other decent OS that can run Root and GEANT4.
+
+### Installation ###
+###### C++ code compilation ######
+
+Clone the musrSim repository git clone https://zaher-salman@bitbucket.org/zaher-salman/musrsim.git
+    cd musrsim
+    mkdir build
+    cd build
+	cmake ../
+    make -j8
+    make install
+    
+This will install the `musrSim` in `/usr/local/bin`, but can be moved to any other directory in your `PATH`.
+
+###### Running the simulation ######
+
+Prepare a file with your beamline and spectrometer design following the instruction in the musrSim manual, finlename.mac.
+
+    musrSim filename.mac
+
+
+### Contact ###
+Zaher Salman <zaher.salman@psi.ch>