mainPage.h

Go to the documentation of this file.

/* FreeEMS - the open source engine management system
 *
 * Copyright 2010 Fred Cooke
 *
 * This file is part of the FreeEMS project.
 *
 * FreeEMS software is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FreeEMS software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with any FreeEMS software.  If not, see http://www.gnu.org/licenses/
 *
 * We ask that if you make any changes to this file you email them upstream to
 * us at admin(at)diyefi(dot)org or, even better, fork the code on github.com!
 *
 * Thank you for choosing FreeEMS to run your engine!
 */

/** @mainpage FreeEMS
 * @anchor doxygenMainPageTop
 *
 * @b Welcome @b to @b the @b FreeEMS @b project!
 *
 * FreeEMS is a free and open source Engine Management System. It includes both
 * software and hardware designs under free and open source licenses that you
 * can download. FreeEMS firmware is intended to be clean and modular with an
 * emphasis on readability and quality. All feedback is very much appreciated!
 *
 * A log of the work done between this release and the last one can be found on
 * the @ref changeLogs page.
 *
 * A summary of important information about this release can be found on the
 * @ref releaseNotes page.
 *
 * Specific aspects of the firmware are documented, one aspect per page in
 * the <a href="pages.html"><b>Related Pages</b></a> tab.
 *
 * @b Primary @b Authors:
 * - Fred Cooke - Founder, leader and main developer.
 * - Sean Keys - XGATE tools, flash burning code and documentation.
 *
 * @b Contributors:
 *
 * For a fairly comprehensive list of people who have assisted the cause in
 * various ways see the @ref contributors page.
 *
 * @since The first of January 2008
 *
 * @b See @b Also:
 * - <a href="http://www.diyefi.org">DIYEFI.org</a>
 * - <a href="http://forum.diyefi.org">DIYEFI.org forums</a>
 * - <a href="http://forum.diyefi.org/viewforum.php?f=19">DIYEFI.org FreeEMS forums</a>
 * - <a href="http://tools.diyefi.org">FreeEMS/XGATE/S12X Tools</a>
 * - <a href="http://github.com/fredcooke/freeems-vanilla/">FreeEMS Vanilla Git source repository on GitHub.com</a>
 * - <a href="https://www.ohloh.net/p/freeems">FreeEMS code statistics by ohloh.net</a>
 * - <a href="http://issues.freeems.org">MantisBT issue tracking for FreeEMS and related projects</a>
 * - <a href="http://wiki.freeems.org">DokuWiki Wiki for FreeEMS user documentation</a>
 * - <a href="http://downloads.freeems.org">FreeEMS Downloads</a>
 * - <a href="http://docs.freeems.org">The online version of this documentation and more</a>
 *
 * For a summary of available documentation and information, please visit <a href="http://docs.freeems.org">http://docs.freeems.org</a>
 *
 * @b Licensing:
 * - 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>.
 */

/** @file
 *
 * @ingroup doxygenDocFiles
 * @brief Doxygen Main index page definition
 */