/*
 * Copyright (c) 2020-2023 Gustavo Valiente gustavo.valiente@protonmail.com
 * zlib License, see LICENSE file.
 */

#ifndef BN_DOCUMENTATION_MAIN_PAGE_H
#define BN_DOCUMENTATION_MAIN_PAGE_H

/**
 * @mainpage Butano
 *
 * Butano is a modern C++ high level engine for the
 * <a href="https://en.wikipedia.org/wiki/Game_Boy_Advance">Game Boy Advance</a>.
 *
 * This is the documentation for the Butano engine. To see a high-level overview,
 * go to the <a href="https://github.com/GValiente/butano">GitHub main page</a>.
 *
 * Thanks to the <a href="https://magnum.graphics/">Magnum Project</a> for its awesome documentation!
 * This documentation is heavily based on it.
 *
 *
 * @section main_whats_new What's new?
 *
 * Check out the @ref changelog "changelog".
 *
 *
 * @section main_getting_started Getting started
 *
 * The best way to get started is to read the
 * @ref getting_started "guide to download, install and start using Butano".
 * After that, there are various @ref examples "examples" explaining most aspects of the engine.
 * At last, check how to @ref import "import" your own assets in a game and
 * take a look at the <a href="modules.html">modules</a> page.
 * The @ref faq "frequently asked questions (FAQ)" are worth a look too.
 *
 *
 * @section main_contact_support Contact and support
 *
 * If you spotted a bug, need a feature or have an awesome idea,
 * the best you can do is to head over to <a href="https://github.com/GValiente/butano">GitHub</a>
 * and to the <a href="https://discord.io/gbadev">gbadev Discord server</a>.
 *
 *
 * @section main_licenses Licenses
 *
 * Butano is licensed under the zlib license,
 * see the <a href="https://github.com/GValiente/butano/blob/master/LICENSE">LICENSE</a> file for details.
 *
 * Third party libraries are licensed under other licenses,
 * please check the <a href="https://github.com/GValiente/butano/blob/master/licenses">licenses</a> folder for details.
 *
 * Assets used in games, examples and other projects are licensed under other licenses,
 * please check the `credits` folders for details.
 */

#endif
