mirror of
https://github.com/changkun/modern-cpp-tutorial.git
synced 2025-12-17 04:34:40 +03:00
see #12: translation of contributing and community
This commit is contained in:
Changkun Ou
13
COMMUNITY.md
Normal file
13
COMMUNITY.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# 交流
|
||||
|
||||
本书有以下读者交流群，有兴趣的读者可以加入，加群需正确回答加群密码：
|
||||
|
||||
|
||||
|
||||
> 提示: `bW9kZXJuLWNwcC10dXRvcmlhbC1naXRodWI=`
|
||||
|
||||
# Community
|
||||
|
||||
The book offers a telegram chat group, feel free to join if you are interested:
|
||||
|
||||
[](https://t.me/joinchat/FEeulBM5OVYzuDI4phQ9Mg)
|
||||
@@ -1,7 +1,5 @@
|
||||
# 如何参与贡献
|
||||
|
||||
[](./assets/community.md)
|
||||
|
||||
## 提交 Issue
|
||||
|
||||
『C++ 11/14/17/20』的 issue 用于追踪书中存在的原则性的描述错误、存在的 `typo` 错误，以及向本书作者提问等。
|
||||
@@ -38,3 +36,36 @@
|
||||
- [ ] 只改动原书正文 `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.
|
||||
19
DONATE.md
Normal file
19
DONATE.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: 资助
|
||||
type: about
|
||||
order: 1
|
||||
---
|
||||
|
||||
# 资助
|
||||
|
||||
如果你认为本书对你起到了帮助，并希望赞助作者，可以通过下面的二维码给予支持：
|
||||
|
||||
|微信|支付宝|
|
||||
|:--:|:--:|
|
||||
| | |
|
||||
|
||||
# Donate
|
||||
|
||||
I would love if you support me to make the book better:
|
||||
|
||||
[](https://www.paypal.me/ouchangkun/4.99eur)
|
||||
@@ -1,8 +1,8 @@
|
||||
<img src="assets/cover-2nd-en.png" alt="logo" height="600" align="right" />
|
||||
<img src="assets/cover-2nd-en.png" alt="logo" height="550" align="right" />
|
||||
|
||||
# C++11/14/17/20 On the Fly
|
||||
|
||||
 [](./README.md) [](./README-en-us.md) [](./assets/donate.md) [](./assets/community.md)
|
||||
[](./README.md) [](./README-en-us.md) [](./DONATE.md) [](./COMMUNITY.md)
|
||||
|
||||
## Purpose
|
||||
|
||||
@@ -16,7 +16,7 @@ In addition, The author would like to encourage that readers should be able to u
|
||||
|
||||
## Targets
|
||||
|
||||
- This book assumes that readers are already familiar with traditional C++ (e.g. C++98), at least they do not have any difficulty in reading traditional C++ code. In other words, those who have long experience in traditional C++ and people who desire to quickly understand the features of modern C++ in a short period of time are well suited to read the book;
|
||||
- This book assumes that readers are already familiar with traditional C++ (i.e. C++98 or earlier), at least they do not have any difficulty in reading traditional C++ code. In other words, those who have long experience in traditional C++ and people who desire to quickly understand the features of modern C++ in a short period of time are well suited to read the book;
|
||||
|
||||
- This book introduces to a certain extent of the dark magic of modern C++. However, these magics are very limited, they are not suitable for readers who want to learn advanced C++. The purpose of this book is offering a quick start for modern C++. Of course, advanced readers can also use this book to review and examine themselves on modern C++.
|
||||
|
||||
@@ -42,9 +42,11 @@ The source code of the [website](https://changkun.de/modern-cpp) of this book ca
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
This book is originally written in Chinese.
|
||||
This book was originally written in Chinese by [Changkun Ou](https://changkun.de).
|
||||
|
||||
The author has limited time and language skills. If readers find any mistakes of the book or any language improvements, please feel free to open an [Issue](https://github.com/changkun/modern-cpp-tutorial/issues) or start a [Pull request](https://github.com/changkun/modern-cpp-tutorial/pulls).
|
||||
The author has limited time and language skills. If readers find any mistakes of the book or any language improvements, please feel free to open an [Issue](https://github.com/changkun/modern-cpp-tutorial/issues) or start a [Pull request](https://github.com/changkun/modern-cpp-tutorial/pulls). For detailed guidelines and checklist, please refer to [How to contribute](CONTRIBUTING.md).
|
||||
|
||||
The author would be grateful to all contributors, including but not limited to [Contributors](https://github.com/changkun/modern-cpp-tutorial/graphs/contributors).
|
||||
|
||||
## Licenses
|
||||
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
|
||||
# 《高速上手 C++11/14/17/20》
|
||||
|
||||
[](./README.md) [](./README-en-us.md)
|
||||
[](./assets/donate.md)
|
||||
[](./README.md) [](./README-en-us.md) [](./DONATE.md) [](./COMMUNITY.md)
|
||||
|
||||
## 本书目的
|
||||
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
# Community
|
||||
|
||||
This book offers a reader community, you can join this Telegram:
|
||||
|
||||
TBA
|
||||
@@ -1,7 +0,0 @@
|
||||
# 交流
|
||||
|
||||
本书有以下读者交流群，有兴趣的读者可以加入，加群需正确回答加群密码：
|
||||
|
||||
|
||||
|
||||
> 提示: `bW9kZXJuLWNwcC10dXRvcmlhbC1naXRodWI=`
|
||||
@@ -1,5 +0,0 @@
|
||||
# Donate
|
||||
|
||||
To donate the author:
|
||||
|
||||
TBA
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
title: 资助
|
||||
type: about
|
||||
order: 1
|
||||
---
|
||||
|
||||
# 资助
|
||||
|
||||
如果你认为本书对你起到了帮助，并希望赞助作者，可以通过下面的二维码给予支持：
|
||||
|
||||
|微信|支付宝|
|
||||
|:--:|:--:|
|
||||
| | |
|
||||
@@ -4,7 +4,7 @@ all: clean
|
||||
cp ../assets/cover-2nd.png ./src/modern-cpp/assets/cover-2nd.png
|
||||
cp ../assets/alipay.jpg ./src/modern-cpp/assets/alipay.jpg
|
||||
cp ../assets/wechat.jpg ./src/modern-cpp/assets/wechat.jpg
|
||||
cp ../assets/donate.md ./src/modern-cpp/about/
|
||||
cp ../DONATE.md ./src/modern-cpp/about/
|
||||
cp -r ../assets/figures ./src/modern-cpp/assets/figures
|
||||
cp -r ../exercises ./src/modern-cpp/book/
|
||||
cp -r ../code ./src/modern-cpp/book/
|
||||
|
||||
Reference in New Issue
Block a user