added CMake install documentation
authorDawid Jagiela <lightnir@chem.univ.gda.pl>
Fri, 6 Jul 2012 09:51:03 +0000 (11:51 +0200)
committerDawid Jagiela <lightnir@chem.univ.gda.pl>
Fri, 6 Jul 2012 09:51:03 +0000 (11:51 +0200)
.gitignore
doc/INSTALL/HOWTO_build_unres_with_cmake.pdf [new file with mode: 0644]
doc/INSTALL/HOWTO_build_unres_with_cmake.tex [new file with mode: 0644]

index 25485f3..7fe4126 100644 (file)
 # 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 (file)
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 (file)
index 0000000..dabb02e
--- /dev/null
@@ -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}
+