tech_doc_index.h

// © Copyright 2010 - 2016 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine 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.

    The Mezzanine Engine 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 The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef _dox_tech_doc_index_h
#define _dox_tech_doc_index_h


/**
    @page tech_doc_index Technical Document Index
    Walkthroughs and human level explanations of our tools, processes and anything else useful.

    @section best_practices_menu Best Practices
    Advice that we try to follow on using our tools to make the best of the complex situations we
    deal with when writing software.
     - @ref best_practices_doxygen

    @section dev_tools_menu Development Tools
    What tools do you need to work on the Mezzanine and/or compile it yourself.
     - @ref dev_tools_windows
     - @ref dev_tools_linux
     - @ref dev_tools_mac

    @section building_the_engine_menu Building The Engine
    Installing The required dependencies differs greatly by platform.
     - @ref installing_engine_deps_windows
     - @ref installing_engine_deps_linux
     - @ref installing_engine_deps_macosx

    Building the Engine differs is pretty similar on most platforms.
     - @ref building_the_engine

    @section other_docs_menu Other Documents.
     - @ref running_doxygen
     - @ref cxx_training_and_tools
     - @ref path_on_windows
     - @ref jagati_package
*/

#endif