INSTALL

******************************************************************************
*
*                  ESPResSo installation
*
******************************************************************************

The ESPResSo compilation and installation process is decribed in
detail in the ESPResSo user's guide. When you have obtained the
sources in a .tar.gz file, the user's guide can be found in the file
"index.html" in the subdirectory "doc/sphinx/html/" relative to the directory where
this file resided.

When you have obtained the sources from the git repository or by other
means, the user's guide can always be found on the ESPResSo-Homepage at

	http://espressomd.org/html/doc/


QUICK START
-----------
The recommended way is to build by the cmake tool.
CMake recommends to build in a build directory not inside the
source. On Linux you can create and enter directory in a location
of your choice by

> mkdir <path-to-build-dir> && cd <path-to-build-dir>

Then you can run cmake and build ESPResSo by

> cmake <path-to-espresso-source>
> cmake --build .

If you have installed the curses frontend to cmake you can see
and modify the build options graphically by running

> ccmake <path-to-espresso-source>

When these steps have completed successfully, you can run Espresso with
help of the command

> ./pypresso

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.


LICENSE
-------
Copyright (C) 2010,2011,2012,2013,2014 The ESPResSo project

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.