主页
=====

.. image:: ./_static/html_logo.png
    :height: 100
    :width: 342.5
    :align: center

.. centered:: **让欣赏的归欣赏，管理的归管理**

欢迎使用 ADM 项目\ [1]_\ ，这是一款针对重症仓鼠病爱好者开发的软件，\
其集成了本地数据库管理，网络通讯以及文件批处理功能。本软件目的在于缩短\
浪费在整理资源上的时间，使得文件整理变得简单和便捷，同时不必为可以交给\
软件自动化的事情而费心。

ADM项目立足于让欣赏变得简单和纯粹。

.. [1] 本项目全称为 Anime Database Manager，但为了简介起见，以下均简称为 ADM

以下是ADM项目的主要功能

+ **文件处理**:
+ **文件夹整理**:

.. seealso::
    假如你需要一个兼顾管理和跨平台播放的软件，或者想试一试有着类似功能的软件，\
    `Emby <https://emby.media/>`__\ 、\
    `tinyMediaManager <https://www.tinymediamanager.org/>`__\ 以及\
    `KODI <https://kodi.tv/>`__\ 或许是一个不错的选择。

.. todo::
    补齐主要功能列表

接下来你可以从下方的第一个文档开始，通过精心设计的例子循序渐进的学习ADM的基本操作，\
或者选择一个随机的页面进行探索。

.. _usage:

快速上手
---------

这部分介绍了ADM项目最基础的功能，提供了项目的安装说明以及一个简易的入门教程，\
如果你是第一次接触本项目，请务必仔细阅读本部分的内容。

看完之后也可以继续看看用户指南。

.. toctree::
    :maxdepth: 2
    :caption: 快速上手

    usage/using
    usage/installing
    usage/tutorial

.. _guides:

用户指南
---------

这部分涵盖了ADM项目绝大部分的操作指南，其旨在全面和独立的介绍软件每一个功能\
的使用。这部分内容比较长，因此建议先粗略的浏览一遍指南，然后再选择性的挑选\
你感兴趣的内容进行阅读。

.. note::
    在软件更新的过程中，该部分可能与最新的改动并不同步，所以如果你发现了某处遗漏，请通过\
    界面上方的 :guilabel:`GitHub 图标` 及时向我们反馈。

.. tip::
    软件在更新迭代的过程中会不时的新增许多有趣的功能，因此不妨偶尔回来看看新增的指南和介绍。

.. toctree::
    :maxdepth: 1
    :caption: 用户指南

    guides/main

.. _extend:

拓展
--------

如果你希望为ADM的生态尽一份力量；或者想知晓如何在ADM的基础上进行新的创新，那么\
这个部分便是为富有创造力的你而准备的！

这部分包括了插件编写的详细说明，你可以选择跟随着教程学习如何开发一个简单的拓展，\
亦或可以阅读配套的接口文档，打造属于你的独一无二的ADM。

放轻松，开发拓展并没有你想象中的那么复杂！

.. toctree::
    :maxdepth: 2
    :caption: 拓展

    extend/tutorial
    extend/next

.. _reference:

参考
----------

这部分记录了ADM项目的结构层次以及详细的代码文档，如果你在编写插件的过程中遇到问题，\
或者想了解ADM项目的运行原理，这个部分的文档或许是一个不错的选择。

词汇表记录了常用的术语的含义，你也可以通过更新日志了解项目的最新进展。

.. toctree::
    :maxdepth: 1
    :caption: 参考

    reference/docs
    reference/glossary
    reference/changelog
    reference/todo