diff --git a/README.md b/README.md index e69de29..e0f163c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,18 @@ +# CERN MedTech:Hack More bang from your beam: reimagining X-ray conversion +Simulate X-ray with CERN tools. +### Prerequisites +* Linux or MacOS (Tested on Ubuntu 16.04, MacOS High Sierra 10.13.3 and Linux Subsystem for Windows 10) +* CERN Geant4 +* CMake + +### Building +Clone or download this repository and unpack it if needed. +Open Terminal and insert these by line by line. Change the first line corresponding to your environment. +``` +cd path/to/repo +mkdir build +cd build +cmake ../ +make +./medtech +```