update README

This commit is contained in:
David Baranyai 2018-09-04 20:36:10 +02:00
commit c076786494
1 changed files with 19 additions and 0 deletions

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# SiPM Detector simulation using CERN Geant4
## Description
Simulation of detecting photons using Silicon photomultiplier.
The output file is a ROOT file. Can be checked by TBrowser.
## Prerequisities
* CERN Geant4
* CERN Root (tested on 6.13/03)
* Linux or MacOS (should work on Windows, not tested)
## Building
```
git clone https://git.divaldo.hu/divaldo/SiPM.git
mkdir build_dir && cd build_dir
cmake ../SiPM
make -jN (where N is the number of jobs to run simultaneously)
```