模版(软件的标题,如果是必须付费软件,直接在标题写上“付费”)
朋友你好,如果你有一个很棒的工具希望和大家分享,但是你不知道怎么写一个markdown,这里提供了一个可以参考的模版
简介
我们希望提交的pr在简介部分描述这个工具的:
- 官方的网站(如果有,尽可能以内嵌链接形式嵌入到简介)
- 主要功能
- 使用的环境
- 其他基本的特点
安装
我们希望提交的pr在安装部分描述:
- 软件适配的操作系统的版本
- 安装软件的方式 特别是非Windows操作系统中的安装最好给出指令
- 如果安装这个软件需要提前安装其他的依赖软件,请注明
- 如果可以请提供检查软件成功安装的方法,例如使用
$clang --version
检查clang
是否成功安装
推荐理由
我们希望提交的pr在推荐理由部分描述:
- 这个工具的优点
- 这个工具的缺点
- 这个工具是否开源(开源,但提供付费服务最好标明)
- 如果这个工具不开源,是否免费,是否允许商业化使用,是否提供教育版
- 如果这个工具需要付费,起步价格是多少,如果有其他层级价位,请注明官网定价链接
参考
我们希望提交的pr在参考部分提供一些常用的参考,例如:
- 工具的官方文档
- 笔者实际使用中遇到的情况
- 相关的社区,书籍,网页