see #12: use en-us as default language of readme

changkun · Jul 9, 2019 · cd9aae1 · cd9aae1
1 parent da19373
commit cd9aae1
Show file tree

Hide file tree

Showing 6 changed files with 126 additions and 125 deletions.
diff --git a/COMMUNITY.md b/COMMUNITY.md
@@ -1,13 +1,13 @@
-# 交流
+# Community
 
-本书有以下读者交流群，有兴趣的读者可以加入，加群需正确回答加群密码：
+The book offers a telegram chat group, feel free to join if you are interested:
 
-![](qq-group.png)
+[![](https://img.shields.io/badge/chat-telegram-blue.svg?style=popout-square&logo=telegram)](https://t.me/joinchat/FEeulBM5OVYzuDI4phQ9Mg)
 
-> 提示: `bW9kZXJuLWNwcC10dXRvcmlhbC1naXRodWI=`
+# 交流
 
-# Community
+本书有以下读者 QQ 交流群，有兴趣的读者可以加入，加群需正确回答加群密码：
 
-The book offers a telegram chat group, feel free to join if you are interested:
+![](./assets/qq-group.png)
 
-[![](https://img.shields.io/badge/chat-telegram-blue.svg?style=popout-square&logo=telegram)](https://t.me/joinchat/FEeulBM5OVYzuDI4phQ9Mg)
+> 提示: `bW9kZXJuLWNwcC10dXRvcmlhbC1naXRodWI=`
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,36 @@
+# How to contribute
+
+## Submit Issue
+
+C++ 11/14/17 issue is used to track the principle description error, `typo` error, and the questions to the author of the book.
+
+- Usually, you may encounter typos, semantic errors, grammatical errors, and etc. These are all `typo` errors. If an error has caused some obstacles to your reading and you strongly believe that the `typo` will also affect others reading. Then you are very welcome to [submit issue](https://github.com/changkun/modern-cpp-tutorial/issues) to report the `typo` error.
+
+- Do not hasitate to submit a principle error because it prevent wrong knowledge being propagation.
+Report the error immediately by [submitting issue](https://github.com/changkun/modern-cpp-tutorial/issues) to avoid the spread of wrong knowledge.
+
+- If you found some part of the book is confusing, you are very welcome to [submit an issue](https://github.com/changkun/modern-cpp-tutorial/issues) for asking questions.
+
+- The book cannot cover the entire C++ of course, however, you are very welcome to [submit an issue](https://github.com/changkun/modern-cpp-tutorial/issues) for a suggestion if you found some important feature is missing in the book.
+
+## Pull Request
+
+"C++ 11/14/17 On the Fly" is open source so that everyone can contribute to contribute to PR. However, it is required read the following instructions carefully before submitting your pull request:
+
+- Before you submit your pull request, make sure that the [issue list](https://github.com/changkun/modern-cpp-tutorial/issues) already contains the problem you want to solve. If not, please refer to the **Submit Issue** section.
+
+- Make sure your PR has improved the `typo` error of more than 50 words, otherwise please do not submit a PR.
+
+- For a PR that fixes principled errors, please don't hesitate, all readers of the book are very grateful for your contribution!
+
+- If you would like to be a co-author of this book, please send an email to ask: `hi at changkun dot us`.
+
+Since this repository provides a variety of reading approaches, thus make sure you have checked all items in the following checklist:
+
+ - [ ] If you only making changes to the main part of the book (i.e. the `book` folder), and no changes to the code snippet, then you are good to go;
+- [ ] If you also change the code snippet in the main body of the book, then you need to synchronize the corresponding code snippet in the `code` folder;
+- [ ] If you changes also involve the exercises, you also need to synchronize the contents of the `exercises` folder.
+
 # 如何参与贡献
 
 ## 提交 Issue
@@ -36,36 +69,3 @@
 - [ ] 只改动原书正文 `book` 下的部分内容，不涉及代码片段的修改，则无需进行修改
 - [ ] 如果同时还改动了正文中的代码片段，则需要同步 `code` 文件夹下对应的代码片段
 - [ ] 如果改动还涉及习题的设计，则需要同步 `exercises` 文件夹下的内容
-
-# How to contribute
-
-## Submit Issue
-
-C++ 11/14/17 issue is used to track the principle description error, `typo` error, and the questions to the author of the book.
-
-- Usually, you may encounter typos, semantic errors, grammatical errors, and etc. These are all `typo` errors. If an error has caused some obstacles to your reading and you strongly believe that the `typo` will also affect others reading. Then you are very welcome to [submit issue](https://github.com/changkun/modern-cpp-tutorial/issues) to report the `typo` error.
-
-- Do not hasitate to submit a principle error because it prevent wrong knowledge being propagation.
-Report the error immediately by [submitting issue](https://github.com/changkun/modern-cpp-tutorial/issues) to avoid the spread of wrong knowledge.
-
-- If you found some part of the book is confusing, you are very welcome to [submit an issue](https://github.com/changkun/modern-cpp-tutorial/issues) for asking questions.
-
-- The book cannot cover the entire C++ of course, however, you are very welcome to [submit an issue](https://github.com/changkun/modern-cpp-tutorial/issues) for a suggestion if you found some important feature is missing in the book.
-
-## Pull Request
-
-"C++ 11/14/17 On the Fly" is open source so that everyone can contribute to contribute to PR. However, it is required read the following instructions carefully before submitting your pull request:
-
-- Before you submit your pull request, make sure that the [issue list](https://github.com/changkun/modern-cpp-tutorial/issues) already contains the problem you want to solve. If not, please refer to the **Submit Issue** section.
-
-- Make sure your PR has improved the `typo` error of more than 50 words, otherwise please do not submit a PR.
-
-- For a PR that fixes principled errors, please don't hesitate, all readers of the book are very grateful for your contribution!
-
-- If you would like to be a co-author of this book, please send an email to ask: `hi at changkun dot us`.
-
-Since this repository provides a variety of reading approaches, thus make sure you have checked all items in the following checklist:
-
- - [ ] If you only making changes to the main part of the book (i.e. the `book` folder), and no changes to the code snippet, then you are good to go;
-- [ ] If you also change the code snippet in the main body of the book, then you need to synchronize the corresponding code snippet in the `code` folder;
-- [ ] If you changes also involve the exercises, you also need to synchronize the contents of the `exercises` folder.
diff --git a/DONATE.md b/DONATE.md
@@ -4,16 +4,17 @@ type: about
 order: 1
 ---
 
+# Donate
+
+I would love if you support me to make the book better:
+
+[![](https://img.shields.io/badge/donate-PayPal-104098.svg?style=popout-square&logo=PayPal)](https://www.paypal.me/ouchangkun/4.99eur)
+
 # 资助
 
 如果你认为本书对你起到了帮助，并希望赞助作者，可以通过下面的二维码给予支持：
 
 |微信|支付宝|
 |:--:|:--:|
-|![](../assets/wechat.jpg) | ![](../assets/alipay.jpg)|
+|![](./assets/wechat.jpg) | ![](./assets/alipay.jpg)|
 
-# Donate
-
-I would love if you support me to make the book better:
-
-[![](https://img.shields.io/badge/donate-PayPal-104098.svg?style=popout-square&logo=PayPal)](https://www.paypal.me/ouchangkun/4.99eur)
diff --git a/README-en-us.md b/README-en-us.md
diff --git a/README-zh-cn.md b/README-zh-cn.md
@@ -0,0 +1,48 @@
+<img src="assets/cover-2nd.png" alt="logo" height="550" align="right" />
+
+# 《高速上手 C++11/14/17/20》
+
+[![](https://img.shields.io/badge/language-English-blue.svg?style=flat-square)](./README.md) [![](https://img.shields.io/badge/language-简体中文-red.svg?style=flat-square)](./README-zh-cn.md) [![](https://img.shields.io/badge/€-donate-ff69b4.svg?style=flat-square)](./DONATE.md) [![](https://img.shields.io/badge/chat-community-667ed5.svg?style=flat-square)](./COMMUNITY.md)
+
+## 本书目的
+
+本书号称『高速上手』，从内容上对二十一世纪二十年代之前产生 C++ 的相关特性做了非常相对全面的介绍，读者可以自行根据下面的目录选取感兴趣的内容进行学习，快速熟悉需要了解的内容。这些特性并不需要全部掌握，只需针对自己的使用需求和特定的应用场景，学习、查阅最适合自己的新特性即可。
+
+同时，本书在介绍这些特性的过程中，尽可能简单明了的介绍了这些特性产生的历史背景和技术需求，这为理解这些特性、运用这些特性提供了很大的帮助。
+
+此外，笔者希望读者在阅读本书后，能够努力在新项目中直接使用现代 C++，并努力将旧项目逐步迁移到现代 C++。也算是笔者为推进现代 C++ 的普及贡献了一些绵薄之力。
+
+## 目标读者
+
+1. 本书假定读者已经熟悉了传统 C++ ，至少在阅读传统 C++ 代码上不具备任何困难。换句话说，那些长期使用传统 C++进行编码的人、渴望在短时间内迅速了解**现代 C++** 特性的人非常适合阅读本书；
+2. 本书一定程度上介绍了一些现代 C++ 的**黑魔法**，但这些魔法毕竟有限，不适合希望进阶学习现代 C++ 的读者，本书的定位系**现代 C++ 的快速上手**。当然，希望进阶学习的读者可以使用本书来回顾并检验自己对 **现代 C++** 的熟悉度。
+
+## 开始阅读
+
+你可以选择以下几种阅读方式：
+
+1. [GitHub 在线](./book/zh-cn/toc.md)
+2. [PDF 文档](./pdf/zh-cn/modern-cpp-tutorial.pdf)
+3. [网站](https://changkun.de/modern-cpp/)
+
+## 相关代码
+
+本书每章中都出现了大量的代码，如果你在跟随本书介绍特性的思路编写自己的代码遇到问题时，不妨读一读随书附上的源码，你可以在[这里](./code)中找到书中介绍过的全部的源码，所有代码按章节组织，文件夹名称为章节序号。
+
+## 随书习题
+
+本书每章最后还加入了少量难度极小的习题，仅用于检验你是否能混合运用当前章节中的知识点。你可以在[这里](exercises)找到习题的答案，文件夹名称为章节序号。
+
+## 本书网站
+
+本书的[网站](https://changkun.de/modern-cpp)源码可以在[这里](./website)找到，由 [hexo](https://hexo.io) 和 [vuejs](https://vuejs.org) 协同构建而成。网站旨在提供一个除 GitHub 之外的阅读方式，除了在桌面端访问之外，你也可以在移动端上阅读本书。
+
+## 致谢
+
+笔者时间和水平有限，如果读者发现书中内容的错误，欢迎提 [Issue](https://github.com/changkun/modern-cpp-tutorial/issues)，或者直接提 [Pull request](https://github.com/changkun/modern-cpp-tutorial/pulls)。详细贡献指南请参考[如何参与贡献](CONTRIBUTING.md)，由衷感谢每一位指出本书中出现错误的读者，包括但不限于 [Contributors](https://github.com/changkun/modern-cpp-tutorial/graphs/contributors)。
+
+## 许可
+
+<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="知识共享许可协议" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/80x15.png" /></a>
+
+本书系[欧长坤](https://github.com/changkun)著，采用[知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议](http://creativecommons.org/licenses/by-nc-nd/4.0/)许可。项目中代码使用 MIT 协议开源，参见[许可](./LICENSE)。