Skip to content

Atopona/speedfox

 
 

Repository files navigation

speed_logo_black_background

SpeedFox 极狐游戏加速器

构建状态

懒得写,晚点补作业

项目特点 ✨

Todo

目录

背景

因为现在 Github 上的中国程序员越来越多,但是 Github 还是以英文为主导,对某些英语能力较弱的中国人不友好。所以,我根据 @RichardLitt 主导的标准 README 项目 RichardLitt/standard-readme 编写了中文版的标准 README 。

安装

Github 上的 README 一般是用 Markdown 编写的,所以后缀名是 .md 。所以你需要一个 Markdown 编辑器,我个人推荐使用 Visual Studio Code

用法

你可以直接下载 README.md 文件或者用 git 克隆此工程。然后使用 Visual Studio Code 等 Markdown 编辑器打开 README.md 文件,然后根据 README.md 的标准格式套用到你自己项目的 README 中。

使用 Markdown 语法编辑 README 。

  • 目录下的项是一个项目的 README 一般需要包含的内容。
  • 背景项下,说明该项目的开发背景,简要概述一下整个项目。
  • 安装项下,说明整个项目的安装方法,尽量详细一点,如果篇幅过大可以另用其他文档描述。
  • 用法项下,说明该项目的使用方法,尽量详细,如果篇幅过大也可以另用其他文档进行描述。
  • 相关项目项下写明与该项目相关的其他项目,如果没有,可以不写。
  • 主要项目负责人项下,写明该项目由谁负责。
  • 参与贡献方式项下,说明如何参与贡献该项目。在贡献人员项下,写明全部或者主要的贡献人员,以向他们表示感谢。
  • 开源协议项下,写明该项目的开源协议。

除上述的之外,还可以根据自己的具体项目进行调整增添删减。也可以适当在 README 中加入徽章,例如本文件的开头的:

相关项目

暂无

主要项目负责人

@sunnny516

参与贡献方式

提交 PR 申请,我会视情况通过。

贡献人员

感谢所有贡献的人,一起帮我维护这座屎山。

开源协议

MIT © Speed Fox

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 83.8%
  • CSS 9.2%
  • HTML 6.2%
  • Other 0.8%