# Ingenic_software

**Repository Path**: ingenic-dev/ingenic_software

## Basic Information

- **Project Name**: Ingenic_software
- **Description**: 君正技术支持文档仓库。
- **Primary Language**: C/C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 13
- **Forks**: 2
- **Created**: 2022-09-16
- **Last Updated**: 2026-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Ingenic Software Support文档仓库

君正支持文档仓库，记录各芯片平台的常见问题、调试方法与测试实践。

## 文档总览

- 芯片平台支持文档
  - [X1600](./X1600/README.md)
  - [X2000](./X2000/README.md)
  - [X2500](./X2500/README.md)
  - [M300](./M300/README.md)
  - [X2600](./X2600/README.md)
- 通用支持与Q&A文档
  - [Support_Common_QA](./Support_Common_QA/README.md)
- 通用文档（平台无关）
  - [Common_Docs](./Common_Docs/README.md)
- 性能测试文档
  - [Performance_Test](./Performance_Test/README.md)
- 环境搭建文档
  - [Env_Build](./Env_Build/README.md)

## 推荐目录结构

```text
ingenic_software/
├── README.md
├── README.en.md
├── X1600/
├── X2000/
├── X2500/
├── M300/
├── Support_Common_QA/
├── Common_Docs/
├── Performance_Test/
└── Env_Build/
```

## 文档组织规范

- 按平台分类：平台文档统一放在对应芯片目录下。
- 按类型分类：优先使用 `Example`、`How_To_Add`、`How_To_Debug`、`Q&A`、`How_To_Test` 等固定分类。
- README 作为入口：每个一级目录必须有 `README.md`，用于索引子文档。
- 文件名清晰：文件名直接表达主题，避免无意义缩写。
- 链接优先相对路径：便于本地浏览和仓库迁移。

## 维护建议

- 新增文档时，同时更新对应目录的 `README.md`。
- 避免把同一主题拆分到多个目录，优先在同一目录集中维护。
- 历史文档可保留原文，但建议在 README 中补充用途说明。

## 可视化导航

- 浏览器入口页：[`docs/index.html`](./docs/index.html)