mirror of https://gitee.com/openkylin/genmai.git
64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
# genmai
|
||
|
||
#### 介绍
|
||
genmai力图实现包含**主机漏洞扫描**和**网络漏洞扫描**功能的安全扫描框架。
|
||
#### 名字
|
||
genmai这个名字来源于中国医术中的术语——“诊脉”，音标为“[dʒen'maɪ]”。脉诊是以手指按切病人动脉以了解病情的内在变化也称切脉。
|
||
|
||
#### 软件架构
|
||
amd64
|
||
|
||
#### 目录说明
|
||
* data : 一些数据文件的目录
|
||
* docs : 文档目录，包括设计文档，说明文档
|
||
* examples : 使用示例目录
|
||
* misc : 其他
|
||
* utils : 实用工具目录
|
||
* z-container : 临时存放目录
|
||
* z-testsuit : 存放测试小程序的目录
|
||
* z-trash : 垃圾桶目录
|
||
|
||
#### 编译说明
|
||
```bash
|
||
# make
|
||
or
|
||
# make build
|
||
```
|
||
|
||
#### 清理工程
|
||
```bash
|
||
# make clean
|
||
or
|
||
# make realclean
|
||
```
|
||
|
||
#### 安装教程
|
||
|
||
1. xxxx
|
||
2. xxxx
|
||
3. xxxx
|
||
|
||
#### 使用说明
|
||
|
||
1. xxxx
|
||
2. xxxx
|
||
3. xxxx
|
||
|
||
#### 参与贡献
|
||
|
||
1. Fork 本仓库
|
||
2. 新建 Feat_xxx 分支
|
||
3. 提交代码
|
||
4. 新建 Pull Request
|
||
|
||
#### 特技
|
||
|
||
1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
|
||
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
|
||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
|
||
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
|
||
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
||
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
||
|
||
|