From: Dawid Jagiela <lightnir@chem.univ.gda.pl>
Date: Fri, 6 Jul 2012 09:51:03 +0000 (+0200)
Subject: added CMake install documentation
X-Git-Tag: v.3.2~72^2~6^2~1
X-Git-Url: http://mmka.chem.univ.gda.pl/gitweb/?p=unres.git;a=commitdiff_plain;h=0961a908d2479083809d6dca5407d5d0052992cb

added CMake install documentation
---

diff --git a/.gitignore b/.gitignore
index 25485f3..7fe4126 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,6 +11,11 @@
 # ignore build dir
 build/
 
+# latex files in documentation 
+doc/*/*.aux
+doc/*/*.log
+
+
 # ignored dirs form adasko
 gradcheck/
 mapcheck/
diff --git a/doc/INSTALL/HOWTO_build_unres_with_cmake.pdf b/doc/INSTALL/HOWTO_build_unres_with_cmake.pdf
new file mode 100644
index 0000000..962c9c2
Binary files /dev/null and b/doc/INSTALL/HOWTO_build_unres_with_cmake.pdf differ
diff --git a/doc/INSTALL/HOWTO_build_unres_with_cmake.tex b/doc/INSTALL/HOWTO_build_unres_with_cmake.tex
new file mode 100644
index 0000000..dabb02e
--- /dev/null
+++ b/doc/INSTALL/HOWTO_build_unres_with_cmake.tex
@@ -0,0 +1,48 @@
+\documentclass{article}
+
+\newcommand{\shellcmd}[1]{\medskip\texttt{\footnotesize #1}\medskip}
+
+\begin{document}
+
+
+\title{Building UNRESPACK with CMake}
+\author{Dawid Jagiela}
+
+\maketitle
+
+
+\section{Requirements}
+
+Starting with UNRESPACK 3.2, CMake (cross-platform, open-source build system ) can be used to build UNRESPACK. 
+Building requires te folowing: 
+\begin{itemize}  
+  \item CMake 2.8 or later 
+  \item Fortran compiler. Currently \emph{Intel Fortran Compiler} and \emph{GNU Fortran Compiler} are supported. The former one is recomended.  
+  \item ANSI C compiler   
+\end{itemize} 
+
+\section{Building}
+
+\raggedright
+
+Prepare the build directory 
+
+\shellcmd{mkdir unrespack \\tar -xvzf unrespack-v.3.2.tar.gz -C unrespack \\cd unrespack \\mkdir build \&\& cd build}
+
+Configure CMake 
+
+\begin{itemize}
+  \item Using command line, interactive mode(recomended) \shellcmd{ccmake ..}
+  \item Using command line, non-interactive mode. This requires to pass all the variables to CMake
+ 	\shellcmd{ cmake -DCMAKE\_Fortran\_COMPILER=ifort -DUNRES\_MD\_FF=GAB .. } 
+\end{itemize}
+
+To compile the whole package run:
+
+\shellcmd{make}
+
+
+
+
+\end{document}
+