# kiran-manual

**Repository Path**: openeuler/kiran-manual

## Basic Information

- **Project Name**: kiran-manual
- **Description**: 本项目已经迁移至 AtomGit  || This project has been migrated to AtomGit || Linked: https://atomgit.com/openeuler/kiran-manual
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 19
- **Forks**: 5
- **Created**: 2023-08-10
- **Last Updated**: 2025-12-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: sig-KIRAN-DESKTOP

## README

# Notice: This project has been migrated to [AtomGit](https://atomgit.com/openeuler/kiran-manual)
# 通知: 本项目已经正式迁移至 [AtomGit](https://atomgit.com/openeuler/kiran-manual) 平台
# kiran-manual 系统帮助手册
## 安装依赖
```bash
dnf install kiran-log-qt5 kiranwidgets-qt5 kiran-qt5-integration
```

## 编译安装
下列两种方式选择其一即可。

方式一：
```bash
# mkdir build; cd build
# cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=debug ..
# make -j4
# sudo make install
```
方式二：
```bash
# cmake -S . -B build -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=debug
# cmake --build build  -j4 -v
# sudo cmake --install build
```

## 运行
```bash
# /usr/bin/kiran-manual
```

## 文档库目录说明
```bash
.
├── data                 # 数据目录，存放配置文件及文档库
│   ├── documents        # 文档库主目录，存放文档和图片
│   │   ├── images       # 文档库图片
│   │   │   ├── docs     # 文档中的图片
│   │   │   │   ├── template-document-img.png
│   │   │   │   └── ...
│   │   │   └── nav      # 文档导航图片
│   │   │       ├── template-icon.png
│   │   │       └── ...
│   │   └── markdowns    # 文档源 Markdown 文件，包含不同语言
│   │       ├── en_US    # 默认英文
│   │       │   ├── template-app1.md
│   │       │   ├── template-app2.md
│   │       │   └── ...
│   │       ├── zh_CN    # 中文
│   │       │   ├── template-app1.md
│   │       │   ├── template-app2.md
│   │       │   └── ...
│   │       └── ...
│   ├── km.ini           #文档库配置文件
│   └── ...
```