From 05736936a9fc9c0e9787d7de60d08c5074ad7f63 Mon Sep 17 00:00:00 2001 From: Giovanni Bussi <giovanni.bussi@gmail.com> Date: Tue, 11 Apr 2017 09:56:52 +0200 Subject: [PATCH] Made README github friendly --- README | 87 -------------------------------------- README.md | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 124 insertions(+), 87 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 55e6b5eba..000000000 --- a/README +++ /dev/null @@ -1,87 +0,0 @@ -CONTENT - -CHANGES/ : change log -COPYING.LESSER : license -Makefile : makefile -PEOPLE : list of authors -README : this file -configurations/ : template configuration files -configure : configuration script -developer-doc : developer documentation -patches : set of diff and patch scripts, needed to embed plumed in MD programs -regtest : extensive set of regression tests, including reference results -scripts : shell tools -src : source code -test : examples -user-doc : user documentation - -INSTALL - -Extensive installation instructions are in the user documentation. -Links to precompiled versions of the documentation can be found here: -http://www.plumed.org/documentation - -Needed software: -* GNU make -* c/c++ compiler (c++11 support is required as of version 2.4). -* a modern version of the "patch" -* support for POSIX library dirent.h -* xxd (present in most unix distributions) - -Suggested software (libraries are checked during configure and enabled if available): -* optimized blas and lapack libraries, can be replaced by an internal version if not available -* MPI library to run parallel simulations -* VMD molfile plugins (www.ks.uiuc.edu/Research/vmd/plugins) to read arbitrary file formats, - can be replaced by an internal version supporting a few formats if not available -* matheval library (www.gnu.org/software/libmatheval) to use algebraic collective variables -* doxygen (www.doxygen.org) to build user manual -* latex to build the user manual - used by doxygen -* graphviz (www.graphviz.org) to show class hierarchy in developer manual - used by doxygen - -Quick compilation instructions: -* configure for your system: -> ./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 the path -> plumed help -* compile the manuals -> make doc - -The starting point for user documentation is -user-doc/html/index.html - -The starting point for developer documentation is -developer-doc/html/index.html - -* To install plumed in $HOME/opt (set during configure): -> umask 022 -> make install -* A sample modulefile with environment variable will be placed in -$HOME/opt/lib/plumed/src/lib/modulefile -* Path to installed documentation can be found with command -> plumed info --user-doc - - -GIT VERSION - -Several branches and tags are stored on the git repository. - -Branches named v2.X correspond to release branches. - -Master branch may contain non tested features and is not expected to be used by non-developers. -It is typically containing features that will be available on the next release. - -Tags named v2.XbY correspond to beta releases - use with care -Tags named v2.X.Y correspond to official releases - use the latest available. - -To report problems found on beta or official releases, use the normal plumed-users -mailing list. Just state exactly which version you are using. - -To report problems found on master branch, use the plumed2-git mailing list. -This is also the correct place for discussions about new features etc. -When reporting please provide the git hash (get it with "git rev-parse HEAD"). - diff --git a/README.md b/README.md new file mode 100644 index 000000000..00d71211a --- /dev/null +++ b/README.md @@ -0,0 +1,124 @@ + +Content +------- + + CHANGES/ : change log + COPYING.LESSER : license + Makefile : makefile + Makefile.conf.in : template configuration makefile + PEOPLE : list of authors + README : this file + VERSION : version file + configurations/ : template configuration files + configure : configuration script + configure.ac : configuration script (autoconf) + developer-doc : developer documentation + include : symbolic link for include files + macports : directory where Portfiles are generated + patches : patch scripts + release.sh : developer utility to publish releases + regtest : regression tests, including reference results + scripts : shell tools + src : source code + sourceme.sh : template configuration script + test : examples + user-doc : user documentation + vim : directory where vim syntax is generated + +Install +------- + +Extensive installation instructions are in the user documentation. +Links to precompiled versions of the documentation can be found [here](http://www.plumed.org/documentation). + +Required software: + +* GNU make +* C/c++ compiler (c++11 support is required as of version 2.4). +* A modern version of the `patch` command line tool +* Support for POSIX library `dirent.h` +* `xxd` (present in most unix distributions) + +Suggested software (libraries are checked by `./configure` and enabled if available): + +* Optimized blas and lapack libraries. Can be replaced by an internal version if not available. +* MPI library to run parallel simulations. It should be the same library used by your MD code. +* [VMD molfile plugins](http://www.ks.uiuc.edu/Research/vmd/plugins) to read arbitrary file formats. Can be replaced by an internal version supporting a few formats if not available. +* [Matheval library](http://www.gnu.org/software/libmatheval) to use algebraic collective variables. +* [Zlib library](http://zlib.net/) to use compressed data files. +* [Xdrfile library](http://www.gromacs.org/Developer_Zone/Programming_Guide/XTC_Library) to have read/write access to gromacs + trajectory files. +* [Doxygen](http:://www.doxygen.org) to build user manual. Doxygen might need the following packages: + * Latex to build the pdf user manual. + * [Graphviz](http://www.graphviz.org) to show class hierarchy in + developer manual. + +Quick compilation instructions +------------------------------ + +Configure for your system + + ./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 (pre-compiled manual is available online): + + make doc + +User documentation can be found at `user-doc/html/index.html`. +Developer documentation can be found at `developer-doc/html/index.html`. + +Install PLUMED in `$HOME/opt` (directory should be set during `./configure`): + + umask 022 + make install + +A sample modulefile with environment variable will be placed in +`$HOME/opt/lib/plumed/src/lib/modulefile`. Path to the installed documentation can be found with command `plumed info --user-doc`. + + +Branches and releases +--------------------- + +Several branches and tags are stored on the git repository. + +Branches named `v2.X` correspond to release branches. + +Master branch may contain non tested features and is not expected to be used by non-developers. +It typically contains features that will be available on the next release. + +Tags named `v2.XbY` correspond to beta releases, use it with care. +Tags named `v2.X.Y` correspond to official releases, use the latest available. + +To report problems found on beta or official releases, use the normal `plumed-users@googlegroups.com` +mailing list. Just state exactly which version you are using. + +To report problems found on `master` branch, use the `plumed2-git@googlegroups.com` mailing list. +This is also the correct place for discussions about new features etc. +When reporting please provide the git hash (you can obtain it with `git rev-parse HEAD`). + +Status +------ + +| Branch | Status | Supported | +|:--------:|:-------------:|:--------:| +| master | [](https://travis-ci.org/plumed/plumed2) | yes | +| v2.3 | [](https://travis-ci.org/plumed/plumed2) | yes | +| v2.2 | [](https://travis-ci.org/plumed/plumed2) | no | +| v2.1 | [](https://travis-ci.org/plumed/plumed2) | no | +| v2.0 | Not available | no | + + -- GitLab