src/main/doxy/mainPage.h

   1 /* FreeEMS - the open source engine management system
   2  *
   3  * Copyright 2010 Fred Cooke
   4  *
   5  * This file is part of the FreeEMS project.
   6  *
   7  * FreeEMS software is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * FreeEMS software is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with any FreeEMS software.  If not, see http://www.gnu.org/licenses/
  19  *
  20  * We ask that if you make any changes to this file you email them upstream to
  21  * us at admin(at)diyefi(dot)org or, even better, fork the code on github.com!
  22  *
  23  * Thank you for choosing FreeEMS to run your engine!
  24  */
  25
  26 /** @mainpage FreeEMS
  27  * @anchor doxygenMainPageTop
  28  *
  29  * @b Welcome @b to @b the @b FreeEMS @b project!
  30  *
  31  * FreeEMS is a free and open source Engine Management System. It includes both
  32  * software and hardware designs under free and open source licenses that you
  33  * can download. FreeEMS firmware is intended to be clean and modular with an
  34  * emphasis on readability and quality. All feedback is very much appreciated!
  35  *
  36  * A log of the work done between this release and the last one can be found on
  37  * the @ref changeLogs page.
  38  *
  39  * A summary of important information about this release can be found on the
  40  * @ref releaseNotes page.
  41  *
  42  * Specific aspects of the firmware are documented, one aspect per page in
  43  * the <a href="pages.html"><b>Related Pages</b></a> tab.
  44  *
  45  * @b Primary @b Authors:
  46  * - Fred Cooke - Founder, leader and main developer.
  47  * - Sean Keys - XGATE tools, flash burning code and documentation.
  48  *
  49  * @b Contributors:
  50  *
  51  * For a fairly comprehensive list of people who have assisted the cause in
  52  * various ways see the @ref contributors page.
  53  *
  54  * @since The first of January 2008
  55  *
  56  * @b See @b Also:
  57  * - <a href="http://www.diyefi.org">DIYEFI.org</a>
  58  * - <a href="http://forum.diyefi.org">DIYEFI.org forums</a>
  59  * - <a href="http://forum.diyefi.org/viewforum.php?f=19">DIYEFI.org FreeEMS forums</a>
  60  * - <a href="http://tools.diyefi.org">FreeEMS/XGATE/S12X Tools</a>
  61  * - <a href="http://github.com/fredcooke/freeems-vanilla/">FreeEMS Vanilla Git source repository on GitHub.com</a>
  62  * - <a href="https://www.ohloh.net/p/freeems">FreeEMS code statistics by ohloh.net</a>
  63  * - <a href="http://issues.freeems.org">MantisBT issue tracking for FreeEMS and related projects</a>
  64  * - <a href="http://wiki.freeems.org">DokuWiki Wiki for FreeEMS user documentation</a>
  65  * - <a href="http://downloads.freeems.org">FreeEMS Downloads</a>
  66  * - <a href="http://docs.freeems.org">The online version of this documentation and more</a>
  67  *
  68  * For a summary of available documentation and information, please visit <a href="http://docs.freeems.org">http://docs.freeems.org</a>
  69  *
  70  * @b Licensing:
  71  * - This project is licensed under the GNU GPL v3. The full terms of the license are available <a href="http://www.gnu.org/licenses/gpl-3.0-standalone.html"><b>here</b></a>.
  72  */
  73
  74 /** @file
  75  *
  76  * @ingroup doxygenDocFiles
  77  * @brief Doxygen Main index page definition
  78  */