Skip to content
Snippets Groups Projects
Commit 57edf8b1 authored by Giovanni Bussi's avatar Giovanni Bussi
Browse files

Fixed readme

I think it is better NOT to recommend sourcing "sourceme.sh". Most users
should install plumed with the canonical procedure (make install)
parent 72e09372
No related branches found
No related tags found
No related merge requests found
......@@ -97,37 +97,30 @@ Quick compilation instructions
------------------------------
Extensive installation instructions are in the [user documentation](http://www.plumed.org/documentation).
Configure for your system
Quick instructions:
./configure --prefix=$HOME/opt
If necessary, edit `Makefile.conf`.
Configure your environment
source ./sourceme.sh
Compile plumed
make
The `plumed` executable should be now in your execution path
plumed help
Compile the manuals.
make doc
make doc # optional
User documentation can be found at `user-doc/html/index.html`.
Developer documentation can be found at `developer-doc/html/index.html`.
[Pre-compiled documentation](http://www.plumed.org/documentation) is available online, so this is only required
if you are working with a modified version of the code!
Install PLUMED in `$HOME/opt` (directory should be set during `./configure`):
In order to run PLUMED without installing it you should type `source sourceme.sh`. However,
we recomment installing PLUMED.
To install it in `$HOME/opt` (directory should be set during `./configure`):
umask 022
make install
Now you will be able to run plumed using e.g.
plumed help
If you compiled your own documentation, paths to the installed documentation can be found with command `plumed info --user-doc`.
A sample modulefile with environment variable will be placed in
`$HOME/opt/lib/plumed/src/lib/modulefile`. If you compiled your own documentation, paths to the installed documentation can be found with command `plumed info --user-doc`.
`$HOME/opt/lib/plumed/src/lib/modulefile`. This can be useful if you want to
install multiple PLUMED versions side by side and select them with env modules.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment