diff --git a/Chinese/BLANK_README.md b/Chinese/BLANK_README.md new file mode 100644 index 000000000..3d5864b88 --- /dev/null +++ b/Chinese/BLANK_README.md @@ -0,0 +1,198 @@ + + + + + + +[![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 + + +

项目名称

+ +

+ 项目描述 +
+ 浏览文档 » +
+
+ 查看演示 + · + 报告Bug + · + 请求功能 +

+

+ + + + +
+

目录

 +
    +
  1. + 关于项目 + +
    2. +
  2. + 入门 + +
    3. +
  3. 使用
    4. +
  4. 路线图
    5. +
  5. 贡献
    6. +
  6. 许可证
    7. +
  7. 联系人
    8. +
  8. 致谢
    9. +
+
+ + + + +## 关于项目 + +[![产品名称截图][产品截图]](https://example.com) + +下面是一个空白模板开始: +**以避免重打太多信息. 对以下内容进行搜索并替换为文本编辑器:** +`github_username`, `repo_name`, `twitter_handle`, `email`, `project_title`, `project_description` + + +### 构建 + +* []() +* []() +* []() + + + + +## 入门 + +要创建并运行本地副本，请执行以下简单步骤。 + +### 先决条件 + +这是一个如何列出使用软件所需的内容以及如何安装的示例。 +* npm + ```sh + npm install npm@latest -g + ``` + +### 安装 + +1. 克隆仓库 + ```sh + git clone https://github.com/github_username/repo_name.git + ``` +2. 安装NPM包 + ```sh + npm install + ``` + + + + +## 使用 + +使用此空格显示如何使用项目的有用示例。附加的屏幕截图、代码示例和演示在这个空间中工作得很好。也可以链接到更多资源。 + +有关更多示例，请参阅[文档](https://example.com)_ + + + + +## 路线图 + +查看 [公开问题](https://github.com/github_username/repo_name/issues) 以获取建议功能 (和已知问题)的列表. + + + + +## 贡献 + +贡献使开源社区成为一个值得学习、启发和创造的地方。 **非常感谢**你所做的任何贡献。 + +1. Fork 项目 +2. 创建功能分支 (`git checkout -b feature/AmazingFeature`) +3. 提交更改 (`git commit -m 'Add some AmazingFeature'`) +4. Push 到分支 (`git push origin feature/AmazingFeature`) +5. 打开 Pull 请求 + + + + +## 许可证 + +根据麻省理工学院的许可证(`MIT`) 分发. 查看 `LICENSE` 获取更多信息。 + + + + +## 联系人 + +你的名字 - [@twitter_handle](https://twitter.com/twitter_handle) - 电子邮件 + +项目链接: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name) + + + + +## 致谢 + +* []() +* []() +* []() + + + + + + + +[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo.svg?style=for-the-badge +[contributors-url]: https://github.com/github_username/repo/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/github_username/repo.svg?style=for-the-badge +[forks-url]: https://github.com/github_username/repo/network/members +[stars-shield]: https://img.shields.io/github/stars/github_username/repo.svg?style=for-the-badge +[stars-url]: https://github.com/github_username/repo/stargazers +[issues-shield]: https://img.shields.io/github/issues/github_username/repo.svg?style=for-the-badge +[issues-url]: https://github.com/github_username/repo/issues +[license-shield]: https://img.shields.io/github/license/github_username/repo.svg?style=for-the-badge +[license-url]: https://github.com/github_username/repo/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/github_username diff --git a/Chinese/LICENSE.txt b/Chinese/LICENSE.txt new file mode 100644 index 000000000..ad239f403 --- /dev/null +++ b/Chinese/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Othneil Drew + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Chinese/README.md b/Chinese/README.md new file mode 100644 index 000000000..ad66d80e2 --- /dev/null +++ b/Chinese/README.md @@ -0,0 +1,214 @@ + + + + + + +[![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 + + +

Best-README-Template

+ +

+ An awesome README template to jumpstart your projects! +
+ Explore the docs » +
+
+ View Demo + · + Report Bug + · + Request Feature +

+

+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. + Getting Started + +
    3. +
  3. Usage
    4. +
  4. Roadmap
    5. +
  5. Contributing
    6. +
  6. License
    7. +
  7. Contact
    8. +
  8. Acknowledgements
    9. +
+
+ + + + +## About The Project + +[![Product Name Screen Shot][product-screenshot]](https://example.com) + +There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. + +Here's why: +* Your time should be focused on creating something amazing. A project that solves a problem and helps others +* You shouldn't be doing the same tasks over and over like creating a README from scratch +* You should element DRY principles to the rest of your life :smile: + +Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template! + +A list of commonly used resources that I find helpful are listed in the acknowledgements. + +### Built With + +This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. +* [Bootstrap](https://getbootstrap.com) +* [JQuery](https://jquery.com) +* [Laravel](https://laravel.com) + + + + +## Getting Started + +This is an example of how you may give instructions on setting up your project locally. +To get a local copy up and running follow these simple example steps. + +### Prerequisites + +This is an example of how to list things you need to use the software and how to install them. +* npm + ```sh + npm install npm@latest -g + ``` + +### Installation + +1. Get a free API Key at [https://example.com](https://example.com) +2. Clone the repo + ```sh + git clone https://github.com/your_username_/Project-Name.git + ``` +3. Install NPM packages + ```sh + npm install + ``` +4. Enter your API in `config.js` + ```JS + const API_KEY = 'ENTER YOUR API'; + ``` + + + + +## Usage + +Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. + +_For more examples, please refer to the [Documentation](https://example.com)_ + + + + +## Roadmap + +See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a list of proposed features (and known issues). + + + + +## Contributing + +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + + + + +## License + +Distributed under the MIT License. See `LICENSE` for more information. + + + + +## Contact + +Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com + +Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) + + + + +## Acknowledgements +* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) +* [Img Shields](https://shields.io) +* [Choose an Open Source License](https://choosealicense.com) +* [GitHub Pages](https://pages.github.com) +* [Animate.css](https://daneden.github.io/animate.css) +* [Loaders.css](https://connoratherton.com/loaders) +* [Slick Carousel](https://kenwheeler.github.io/slick) +* [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll) +* [Sticky Kit](http://leafo.net/sticky-kit) +* [JVectorMap](http://jvectormap.com) +* [Font Awesome](https://fontawesome.com) + + + + + + + +[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 diff --git a/Chinese/images/logo.png b/Chinese/images/logo.png new file mode 100644 index 000000000..0f38ba936 Binary files /dev/null and b/Chinese/images/logo.png differ diff --git a/Chinese/images/screenshot.png b/Chinese/images/screenshot.png new file mode 100644 index 000000000..3b58bcb35 Binary files /dev/null and b/Chinese/images/screenshot.png differ