docs/dev-manual/dev-manual.md

   1 Developer manual {#page_devmanual}
   2 ================
   3
   4 This set of pages contains guidelines, instructions, and explanations related
   5 to \Gromacs development.  The actual code is documented in other parts of this
   6 Doxygen documentation.
   7
   8 The focus is (at least for now) on things that are tightly tied to the code
   9 itself, such as helper scripts that reside in the source repository, and may
  10 require the documentation to be updated in sync.  Wiki pages at
  11 <http://www.gromacs.org/Developer_Zone> contain additional information (much of
  12 it outdated, though), and can be linked from relevant locations in this guide.
  13
  14  - \subpage page_devtools <br/>
  15    Documentation for tools used
  16
  17  - \subpage page_devstyle <br/>
  18    Guidelines to follow when writing new code. For some of the guidelines,
  19    scripts exist (see \ref page_devtools) to automatically reformat the code
  20    and/or enforce the guidelines for each commit.