forked from espressomd/espresso
-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL
executable file
·76 lines (53 loc) · 2.28 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
******************************************************************************
*
* 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
"ug.pdf" in the subdirectory "doc/ug/" 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 be found on the ESPResSo-Homepage at
http://espressomd.org
QUICK START - CMake (Recommended)
---------------------------------
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>
> make
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
> ./Espresso
QUICK START - Autotools (Deprecated)
------------------------------------
In most cases, once you have obtained the sources, compiling and
running ESPResSo requires only two steps:
> ./configure
> make
If you have the development sources (obtained from out git source code
repository), you first have to execute
> ./bootstrap.sh
to generate the required configure script.
When these steps have completed successfully, you can run Espresso with
help of the command
> ./Espresso
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.