Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/multi language switching #87

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions BLANK_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,35 @@
</p>
</div>

<!--
*** If the README.txt has multiple languages, create README-*.md files in different languages in /docs and then link them here.
*** I hope that others will also help to improve and add various language versions
-->
<!--
<p align="center">
<a href="/docs/README_zh_cn.md">简体中文</a>
·
<a href="/docs/README_fr.md">Français </a>
·
<a href="/docs/README_es.md">Español</a>
·
<a href="/docs/README_de.md">Deutsch</a>
·
<a href="/docs/README_ja.md">日本語</a>
·
<a href="/docs/README_pt-BR.md">Português Brasileiro</a>
·
<a href="/docs/README_it.md">Italiano</a>
·
<a href="/docs/README_kr.md">한국어</a>
.
<a href="/docs/README_nl.md">Nederlands</a>
.
<a href="/docs/README_np.md">नेपाली</a>
.
<a href="/docs/README_tr.md">Türkçe</a>
</p>
-->


<!-- TABLE OF CONTENTS -->
Expand Down
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,38 @@
·
<a href="https://github.com/othneildrew/Best-README-Template/issues">Request Feature</a>
</p>


<!--
*** If the README.txt has multiple languages, create README-*.md files in different languages in /docs and then link them here.
*** I hope that others will also help to improve and add various language versions
-->
<p align="center">
<a href="/docs/README_zh_cn.md">简体中文</a>
<!--
·
<a href="/docs/README_fr.md">Français </a>
·
<a href="/docs/README_es.md">Español</a>
·
<a href="/docs/README_de.md">Deutsch</a>
·
<a href="/docs/README_ja.md">日本語</a>
·
<a href="/docs/README_pt-BR.md">Português Brasileiro</a>
·
<a href="/docs/README_it.md">Italiano</a>
·
<a href="/docs/README_kr.md">한국어</a>
.
<a href="/docs/README_nl.md">Nederlands</a>
.
<a href="/docs/README_np.md">नेपाली</a>
.
<a href="/docs/README_tr.md">Türkçe</a>
-->
</p>

</div>


Expand Down
281 changes: 281 additions & 0 deletions docs/README_zh_cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
<div id="top"></div>
<!--
*** 感谢查看我们的最佳 README 模板,如果你有好的建议,请复刻(fork)本仓库并且创建一个
*** 拉取请求(pull request),或者直接创建一个带「enhancement」标签的议题(issue)。
*** 不要忘记给该项目点一个 star!
*** 再次感谢!现在快去创建一些了不起的东西吧!:D
-->



<!-- 项目 SHIELDS -->
<!--
*** 我们使用了 markdown 「参考风格」的链接以便于阅读。
*** 参考链接是用方括号 [ ] 包围起来的,而非 圆括号 ( )。
*** 请到文档末尾查看 contributors-url、forks-url 等变量的声明。这是一种可选的简洁语法,你可能会想要使用。
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]



<!-- 项目 LOGO -->
<br />
<div align="center">
<a href="https://github.com/othneildrew/Best-README-Template">
<img src="../images/logo.png" alt="Logo" width="80" height="80">
</a>

<h3 align="center">Best-README-Template-zh_CN</h3>

<p align="center">
让你快速开始构建项目的最佳 README 模板!
<br />
<a href="https://github.com/othneildrew/Best-README-Template"><strong>浏览文档 »</strong></a>
<br />
<br />
<a href="https://github.com/othneildrew/Best-README-Template">查看 Demo</a>
·
<a href="https://github.com/othneildrew/Best-README-Template/issues">反馈 Bug</a>
·
<a href="https://github.com/othneildrew/Best-README-Template/issues">请求新功能</a>
</p>
</div>


<!--
*** 如果你的 README.txt 是多语言的, 请将其它语言版本的 README-*.md 文件存入/docs中,并且在下面的链接中添加它们。
*** 希望其他人也能帮助完善和添加各种语言版本。
-->
<p align="center">
<a href="/README.md">English</a>
<!--
·
<a href="/docs/README_fr.md">Français </a>
·
<a href="/docs/README_es.md">Español</a>
·
<a href="/docs/README_de.md">Deutsch</a>
·
<a href="/docs/README_ja.md">日本語</a>
·
<a href="/docs/README_pt-BR.md">Português Brasileiro</a>
·
<a href="/docs/README_it.md">Italiano</a>
·
<a href="/docs/README_kr.md">한국어</a>
.
<a href="/docs/README_nl.md">Nederlands</a>
.
<a href="/docs/README_np.md">नेपाली</a>
.
<a href="/docs/README_tr.md">Türkçe</a>
-->
</p>


<!-- 目录 -->
<details>
<summary>目录</summary>
<ol>
<li>
<a href="#关于本项目">关于本项目</a>
<ul>
<li><a href="#构建工具">构建工具</a></li>
</ul>
</li>
<li>
<a href="#开始">开始</a>
<ul>
<li><a href="#依赖">依赖</a></li>
<li><a href="#安装">安装</a></li>
</ul>
</li>
<li><a href="#使用方法">使用方法</a></li>
<li><a href="#路线图">路线图</a></li>
<li><a href="#贡献">贡献</a></li>
<li><a href="#许可证">许可证</a></li>
<li><a href="#联系我们">联系我们</a></li>
<li><a href="#致谢">致谢</a></li>
</ol>
</details>



<!-- 关于本项目 -->
## 关于本项目

[![产品截图][product-screenshot]](https://example.com)

GitHub 上有很多优秀的 README 模板,但我没找到一个适合我需求的,所以我创建了这个增强版。我想要创建一个 README 模板,它能优秀到成为你的最后一个 README 模板 —— 我认为这就是你所需要的。

以下是原因:
* 你应该把时间用在项目的「刀刃」上,也就是专注于解决问题本身上
* 你不应该一遍又一遍地做重复的工作,比如每次都从头编写一个 README
* 你应该在未来的生活中始终遵循 DRY 原则 :smile:

当然,没有一个模板可以满足所有项目,因为你的需求可能与众不同。所以我们会在未来添加更多内容。你也可以通过复刻(fork)本仓库并且创建一个拉取请求(pull request)或者创建议题(issue)来向我们提出建议。感谢所有帮助我们扩充本模板的贡献者!

使用 `BLANK_README_zh.md` 来开始。

<p align="right">(<a href="#top">返回顶部</a>)</p>



### 构建工具

你应该在这里列出项目使用的主要框架或库。附加组件和插件则应该放在致谢一节中。下面是一些例子。

* [Next.js](https://nextjs.org/)
* [React.js](https://reactjs.org/)
* [Vue.js](https://vuejs.org/)
* [Angular](https://angular.io/)
* [Svelte](https://svelte.dev/)
* [Laravel](https://laravel.com)
* [Bootstrap](https://getbootstrap.com)
* [JQuery](https://jquery.com)

<p align="right">(<a href="#top">返回顶部</a>)</p>



<!-- 开始 -->
## 开始

这是一份在本地构建项目的指导的例子。
要获取本地副本并且配置运行,你可以按照下面的示例步骤操作。

### 依赖

这只是一个列出软件依赖和安装方法的例子。
* npm
```sh
npm install npm@latest -g
```

### 安装

_下面是一个指导你的受众如何安装和配置你的应用的例子。这个模板不需要任何外部依赖或服务。_

1. 在 [https://example.com](https://example.com) 获取一个免费的 API Key。
2. 克隆本仓库
```sh
git clone https://github.com/your_username_/Project-Name.git
```
3. 安装 NPM 包
```sh
npm install
```
4. 在 `config.js` 中填写你的 API
```js
const API_KEY = '填写你的 API';
```

<p align="right">(<a href="#top">返回顶部</a>)</p>



<!-- 使用方法 示例 -->
## 使用方法

在这里你可以展示项目的使用方法。把附加的截图、代码示例和演示放在这里也很不错。你也可以用链接引用其他资源。

_转到 [文档](https://example.com) 查看更多示例_

<p align="right">(<a href="#top">返回顶部</a>)</p>



<!-- 路线图 -->
## 路线图

- [x] 添加更新日志
- [x] 添加「返回顶部」链接
- [ ] 添加额外的模板和示例
- [ ] 添加「组件」文档,以便更容易复制和粘贴各个部分
- [ ] 多语种支持
- [x] 中文
- [ ] 西班牙语

到 [open issues](https://github.com/othneildrew/Best-README-Template/issues) 页查看所有请求的功能 (以及已知的问题)。

<p align="right">(<a href="#top">返回顶部</a>)</p>



<!-- 贡献 -->
## 贡献

贡献让开源社区成为了一个非常适合学习、启发和创新的地方。你所做出的任何贡献都是**受人尊敬**的。

如果你有好的建议,请复刻(fork)本仓库并且创建一个拉取请求(pull request)。你也可以简单地创建一个议题(issue),并且添加标签「enhancement」。不要忘记给项目点一个 star!再次感谢!

1. 复刻(Fork)本项目
2. 创建你的 Feature 分支 (`git checkout -b feature/AmazingFeature`)
3. 提交你的变更 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到该分支 (`git push origin feature/AmazingFeature`)
5. 创建一个拉取请求(Pull Request)

<p align="right">(<a href="#top">返回顶部</a>)</p>



<!-- 许可证 -->
## 许可证

根据 MIT 许可证分发。打开 [LICENSE.txt](LICENSE.txt) 查看更多内容。


<p align="right">(<a href="#top">返回顶部</a>)</p>



<!-- 联系我们 -->
## 联系我们

你的名字 - [@your_twitter](https://twitter.com/your_username) - email@example.com

项目链接: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)

<p align="right">(<a href="#top">返回顶部</a>)</p>



<!-- 致谢 -->
## 致谢

在这里列出你觉得有用的资源,并以此致谢。我已经添加了一些我喜欢的资源,以便你可以快速开始!

* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
* [Malven's Grid Cheatsheet](https://grid.malven.co/)
* [Img Shields](https://shields.io)
* [GitHub Pages](https://pages.github.com)
* [Font Awesome](https://fontawesome.com)
* [React Icons](https://react-icons.github.io/react-icons/search)

<p align="right">(<a href="#top">返回顶部</a>)</p>



<!-- MARKDOWN 链接 & 图片 -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: images/screenshot.png