# README

## Learn Coding with Open Source

[![Join the chat at https://gitter.im/zhuangbiaowei/learn-with-open-source](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/zhuangbiaowei/learn-with-open-source?utm_source=badge\&utm_medium=badge\&utm_campaign=pr-badge\&utm_content=badge) [![GitHub stars](https://img.shields.io/github/stars/zhuangbiaowei/learn-with-open-source.svg?label=github%20stars)](https://github.com/zhuangbiaowei/learn-with-open-source) [![Powered by Gitbook](https://img.shields.io/badge/Powered%20by-Gitbook-blue)](https://www.gitbook.com) [![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/) [![Actions Status](https://github.com/zhuangbiaowei/learn-with-open-source/workflows/Build%20learn-with-open-source%20PDF/badge.svg)](https://github.com/zhuangbiaowei/learn-with-open-source/actions)

This book uses [GitBook](https://www.gitbook.com) to build.

License: CC BY-NC-SA 4.0

\
All contents licensed under the  [Creative Commons Attribution Non Commercial Share Alike 4.0 license](http://creativecommons.org/licenses/by-nc-sa/4.0/).

Welcome! Join us to finish this book.

You can visit the online ebook: [Learn Coding With Open Source](https://zhuangbiaowei.gitbook.io/learn-with-open-source/)

You can also get the PDF on the release page.

### for developers

#### Build the book

Note: you will need Linux or MacOS. Windows is not yet supported.

1. install [node.js](https://nodejs.org)
2. install [ebook-convert from calibre](http://calibre-ebook.com/download)
   * for pdf,epub etc ebook generation.
   * go Calibre > Misc > Install Command Line Tool after installed
     * or ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin
3. enter the git repository directory

   ```bash
    cd learn-with-open-source
    npm install
   ```
4. generate the ebook via: 1. generate html pages:

   ```bash
    ./node_modules/.bin/gitbook build . _book
   ```

   1. run a local server to read html:

      ```bash
      ./node_modules/.bin/gitbook serve .
      ```
   2. generate the pdf:

      ```bash
      ./node_modules/.bin/gitbook pdf .
      ```

#### Update contributions automatically

It will update contributions through git commits after a pull request or merge is executed. If you want to update it manually:

This script will update the "Contributor.md" file and copy it to the "zh" folder.

```bash
cd learn-with-open-source
./.githooks/post-merge/update-contributors
```

The contributors configuration file is the ".contributors" file on the root of the repository.

#### Update TOC automatically

TODO: this is not finished.

The gitbook uses the SUMMARY.md to get the TOC. The list in the SUMMARY.md will be the TOC.

```
1. [Topic](topic.md)
  1. [SubTopic](subtopic.md)
    1. TheSameFileTopicNoLinkAllowed
    1. TheSameFileTopicNoLinkAllowed
1. [Topic2]
```

**note:**

* the parent directory is not supported via gitbook.
* the topic in the same file could not be a link.

the workflow automation is:

* a text file to determine the markdown files order,

  or use the file name order in a directory.
* get toc of each markdown file.
* merge it into SUMMARY.md

## 《借助开源项目，学习软件开发》

本书使用 [GitBook](https://www.gitbook.com) 来 build 电子书。

联机电子书版本在这里: [Learn Coding With Open Source](https://zhuangbiaowei.gitbook.io/learn-with-open-source/)

开放文档：《借助开源项目，学习软件开发》

诚邀您的参与！

## 著作权申明

License: CC BY-NC-SA 4.0

* 本作品选择采用：署名-非商业性使用-相同方式共享 的CC协议。
  * 您可以：复制、发行、展览、表演、放映、广播或通过信息网络传播本作品。以及创作演绎作品。
  * 惟须遵守下列条件：
    * 署名 — 您必须按照作者或者许可人指定的方式对作品进行署名。
      * 署名方式为：在转载或新作品开头的显著位置，注明原作者的姓名、来源及其采用的知识共享协议，与本作品在Github上的原发地址建立链接
    * 非商业性使用 — 您不得将本作品用于商业目的。
    * 相同方式共享 — 如果您改变、转换本作品或者以本作品为基础进行创作，您只能采用与本协议相同的许可协议发布基于本作品的演绎作品。