docs/index.md

   1 % GROMACS @PROJECT_VERSION@
   2
   3 @DOWNLOAD_SECTION@
   4
   5 [/a/]: # (TODO in release-5-0 branch: consolidate at least some of the material in the Documentation links below into the new user guide, along with all of http://www.gromacs.org/Documentation/Cut-off_schemes, http://www.gromacs.org/Documentation/Acceleration_and_parallelization and http://www.gromacs.org/Documentation/Performance_checklist)
   6
   7 # Documentation
   8
   9 * [Installation Guide](install-guide.html)
  10   As [PDF](install-guide.pdf)
  11
  12 * [User Guide](user-guide.html)
  13   Includes getting started, .mdp options, advice using mdrun and more.
  14   As [PDF](user-guide.pdf)
  15
  16 * [Online Reference](online.html)
  17
  18 * [Reference manual](manual-@PROJECT_VERSION@.pdf) (PDF format)
  19
  20 * [Doxygen public API documentation](doxygen/html-user/index.xhtml)
  21
  22 * Answers to [Frequently Asked Questions](http://www.gromacs.org/Documentation/FAQs)
  23
  24 * Coping with [GROMACS errors](http://www.gromacs.org/Documentation/Errors)
  25
  26 * Links to [tutorial material](http://www.gromacs.org/Documentation/Tutorials)
  27
  28 # Documentation for developers
  29
  30 * [Doxygen code documentation](doxygen/html-lib/index.xhtml)
  31   This contains the public API documentation as a subset, but also has more
  32   details on the internal implementation of GROMACS.
  33
  34 * [Developer Guide](doxygen/html-lib/page_devmanual.xhtml)--
  35   Resources for developers, e.g., related to guidelines and tools used during
  36   development.