diff --git a/README.md b/README.md index 2a87350debc04ea7c61bb85e00b3b0d78d245743..acd155cd9f8a8cb64994793f7e9398d8a297bc85 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,6 @@ For now the installation is done manually by first building SLIC's dependencies ### Initial Setup There will be a `build` dir where all the packages are built and configured and an `install` dir where they are installed out of source. - This structure can be setup as follows: ``` @@ -27,7 +26,41 @@ cd .. mkdir build; cd build ``` -### Geant4 +### Quick Build Instructions + +The SLIC build system is able to download and install all dependencies for the project if they are not found on your system. + +Start by executing CMake from the build dir: + +``` +cd build +cmake .. +``` + +If no directory arguments were provided pointing CMake at locally installed packages, you will see a message stating "Some dependencies were not found." This is not an error, but to complete the build you will need to build these dependencies and then rerun CMake so they are resolved. + +To build the dependencies, execute the following: + +``` +make +``` + +Once this is done, then you need to rerun `cmake ..` from the build directory. If the dependencies all installed successfully, then the message "All dependencies were found." should print. Now you can just type `make; make install` to complete the build using these installed dependencies. + +The default installation directory for SLIC and its dependencies is `~/slic` which you can change by providing an argument `-DGLOBAL_INSTALL_DIR=/my/install/dir` to the CMake command. + +## Running SLIC + +``` +source /scratch/slic/install/slic/bin/slic-env.sh +slic [options] +``` + +## Installing Dependencies + +Should you wish to install dependencies manually, the following instructions can be followed. + +#### Geant4 Download the 10.3.p01 tarball from the Geant4 website and untar it or you may clone a tag from the Geant4 github. @@ -38,7 +71,7 @@ make -j4 make install ``` -### LCIO +#### LCIO ``` git clone https://github.com/iLCSoft/LCIO.git lcio @@ -48,7 +81,7 @@ make -j4 make install ``` -## HepPDT +#### HepPDT ``` wget http://lcgapp.cern.ch/project/simu/HepPDT/download/HepPDT-3.04.01.tar.gz @@ -58,7 +91,7 @@ cd HepPDT-3.04.01 make install ``` -## Xerces +#### Xerces ``` ./configure --prefix=/u/ey/jeremym/hps-dev/slic/install/xerces @@ -66,7 +99,7 @@ make make install ``` -### GDML +#### GDML ``` git clone https://github.com/slaclab/gdml @@ -89,10 +122,3 @@ make -j4 install ``` cmake -DINSTALL_DOC=OFF -DCMAKE_INSTALL_PREFIX=$install_dir/slic -DXERCES_DIR=$install_dir/xerces -DLCIO_DIR=$install_dir/lcio/ -DGeant4_DIR=$install_dir/geant4/lib64/Geant4-10.3.1/ -DGDML_DIR=$install_dir/gdml/ -DHEPPDT_DIR=$install_dir/heppdt -DLCDD_DIR=$install_dir/lcdd .. ``` - -## Running SLIC - -``` -source /scratch/slic/install/slic/bin/slic-env.sh -slic [options] -```