Update user documentation overview
[alexxy/gromacs.git] / docs / user-guide / index.rst
1 .. _user guide:
2
3 **********
4 User guide
5 **********
6
7 .. highlight:: bash
8
9 This guide provides
10
11 * material introducing |Gromacs|
12 * practical advice for making effective use of |Gromacs|.
13
14 For getting, building and installing |Gromacs|, see the
15 :doc:`/install-guide/index`.
16 For background on algorithms and implementations, see the
17 :ref:`reference manual part <gmx-reference-manual-rst>` of the documentation.
18
19 |GMX_MANUAL_DOI_STRING|
20
21 |GMX_SOURCE_DOI_STRING|
22
23 .. TODO This is going to require more organization now that
24    we are getting more content available.
25
26 .. toctree::
27    :maxdepth: 2
28
29    getting-started
30    system-preparation
31    managing-simulations
32    faq
33    force-fields
34    cutoff-schemes
35    cmdline
36    mdp-options
37    mdrun-features
38    mdrun-performance
39    run-time-errors
40    cmdline
41    terminology
42    environment-variables
43    floating-point
44    deprecation-policy