.. X2W-OS documentation master file, created by
   sphinx-quickstart on Tue Apr  4 13:00:00 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

``X2W-OS`` 文档
==================================

本文档是 ``X2W-OS`` 的技术文档，其中包括了 ``X2W-OS`` 的设计说明、API介绍。

   ``X2W-OS`` 是西安交通大学X2W参赛队在2023全国大学生计算机系统能力大赛-操作系统赛-内核实现赛道提交的参赛作品



``X2W-OS`` 的文档中有三类文章：

- **Tutorial**: 编译、运行、调试 ``X2W-OS`` 的教程

- **Developer Notes**: 从开发者的角度出发对 ``X2W-OS`` 的各个模块进行介绍

- **API References**: 对 ``X2W-OS`` 的API进行介绍

具体来说：

- 如果你想开始使用、开发 ``X2W-OS`` ，请阅读 **Tutorial** 中的文章

- 如果你想了解 ``X2W-OS`` 的设计，请阅读 **Developer Notes** 中的文章

- 如果你想查询 ``X2W-OS`` 的函数，请参考 **API References** 中的文章


目录
===================


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: Tutorial:

   docs/*


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: Developer Notes:

   notes/*


.. toctree::
   :glob:
   :maxdepth: 2
   :caption: API References:

   api/*

参考
==================

* :ref:`genindex`
* :ref:`search`