Skip to content

NoobOSLab/noobkernel-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoobKernel Documentation

NoobKernel 是一个用于学习操作系统内核开发的 RISC-V 64 位裸机内核项目文档。

关于本项目

本仓库包含 NoobKernel 的完整技术文档,使用 MkDocs 构建。文档涵盖:

  • 快速入门:环境搭建、编译运行、调试方法
  • 系统架构:内核整体设计、启动流程、内存布局
  • 模块详解:内存管理、进程管理、文件系统等核心模块
  • API 参考:各子系统的编程接口说明
  • 开发指南:路线图、编码规范

环境要求

  • Python 3.11+
  • uv - Python 包管理工具

快速开始

安装依赖

uv sync

构建文档

uv run mkdocs build

构建产物将生成在 site/ 目录。

本地预览

启动本地开发服务器,支持热重载:

uv run mkdocs serve

访问 http://127.0.0.1:8000 查看文档。

项目结构

noobkernel-doc/
├── docs/                    # 文档源文件
│   ├── index.md            # 首页
│   ├── getting-started/     # 快速入门
│   ├── architecture/        # 系统架构
│   ├── modules/             # 模块详解
│   ├── api/                 # API 参考
│   └── development/         # 开发指南
├── mkdocs.yml               # MkDocs 配置
├── pyproject.toml           # Python 项目配置
└── README.md                # 本文件

技术栈

相关链接

License

MIT

About

Documentation for NoobKernel.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors