# codereader

**Repository Path**: tom_zhj/codereader

## Basic Information

- **Project Name**: codereader
- **Description**: 跟大咖一起读源码
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-14
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 今天认真读代码了没

![][1]

我们希望营造一起阅读代码、学习开源项目、共同进步的氛围。

## 项目的阅读

您可以从[https://ymgd.github.io/codereader/](https://ymgd.github.io/codereader/) 看到我们最新发布的文章。

可以从[https://ymgd.github.io/codereader/categories/](https://ymgd.github.io/codereader/categories/) 看到文章按照项目归类组织之后的内容。

## 项目文章的组织

每个开源项目，呈现如下的组织方式：

![][2]

项目的第一篇文章，即是项目的简单介绍，比如上图中Flume项目的例子：

![][3]

其中，

```
项目地址：https://flume.apache.org/
```

是项目托管在官方网站的地址，之中包含了项目的功能描述，说明文档，发布计划等内容。

```
github地址：https://github.com/apache/flume
```

是项目的开源地址，您可以通过类似如下命令，将项目代码下载您本地：

```bash
git clone https://github.com/apache/flume.git
```

或者，您可以在github中将项目fork为自己的。

## 内容贡献

非常期待您的加入，分享您在代码学习过程中的收获和心得。

可以关注我们的项目：

```
https://github.com/ymgd/codereader
```

可以给我们提交PR，也可以通过公众号联系我们。

[1]: pub.jpg
[2]: projectexample.jpg
[3]: readmeexample.jpg