github
/
zhao
mirror of https://github.com/programthink/zhao.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
zhao/README.wiki

125 lines
4.2 KiB
Plaintext
Raw Normal View History

添加项目简介
2016-02-28 23:49:58 +08:00
= 俺整理的《太子党关系网络》 =
添加数据文件说明
2016-03-01 00:25:13 +08:00
== 简介 ==
添加项目简介
2016-02-28 23:49:58 +08:00
此项目专门用来揭露天朝的权贵（也就是传说中的“赵家人”）。
添加项目简介
2016-02-28 23:57:41 +08:00
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
（2月29日）俺把这几年收集整理的数据开源到 GitHub，便于多人协作——大伙儿群策群力，一起来曝光权贵家族。
添加项目简介
2016-03-01 00:10:08 +08:00
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
目前收集的资料——包括700多个数据文件（对应700多人），另有200多张图片（人物头像）。
添加数据文件说明
2016-03-01 00:25:13 +08:00
补充多人协作说明
2016-03-01 15:41:29 +08:00
补充目录说明和脚本使用说明
2016-03-01 09:49:49 +08:00
== 下载说明 ==
补充下载说明
2016-03-01 17:10:15 +08:00
GitHub 提供了“下载整个项目”的功能，但是会比较大。
补充目录说明和脚本使用说明
2016-03-01 09:49:49 +08:00
补充下载说明
2016-03-01 17:10:15 +08:00
如果你仅仅想看《太子党关系网络》这份文档，只需首页上的进入 download 目录。
该目录下有 pdf 和 jpg 两个子目录，分别存放对应的【文件类型】。你想要看哪一种文件格式，就下载哪个子目录里面的文件。
补充目录说明和脚本使用说明
2016-03-01 09:49:49 +08:00
补充多人协作说明
2016-03-01 15:41:29 +08:00
== 多人协作说明 ==
俺非常希望有更多的网友参与该项目，大伙儿一起来完善天朝权贵家族的资料。
想要参与的同学，可以通过如下方式：
* 到[https://program-think.blogspot.com/ 俺博客]留言进行反馈，补充信息或反馈错误。
* 在[https://github.com/programthink/zhao/issues 本项目发一个 issue]，补充信息或反馈错误。
* Fork 该项目，进行修改，然后向俺发一个 Pull Request
（后面两种方式，你需要有 GitHub 的帐号）
添加数据文件说明
2016-03-01 00:25:13 +08:00
== 数据格式说明 ==
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
本项目的数据文件，全部采用[https://zh.wikipedia.org/wiki/YAML YAML 格式]。这种格式非常简洁明了，有利于完全不懂技术的网友参与编辑。
添加数据文件说明
2016-03-01 00:25:13 +08:00
而且俺在每一个 YAML 格式的文件中都写了详细的注释，便于其他网友修改。
补充多人协作说明
2016-03-01 15:41:29 +08:00
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
== 目录说明 ==
添加项目简介
2016-03-01 00:10:08 +08:00
补充目录说明和脚本使用说明
2016-03-01 09:49:49 +08:00
=== data 目录 ===
添加项目简介
2016-03-01 00:10:08 +08:00
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
data 目录用来保存数据文件，该目录下另有如下三个子目录：
添加数据文件说明
2016-03-01 00:25:13 +08:00
* person
这个目录存放个人的资料，每个人一个目录，目录名就是人名。对于偶尔有同名的情况，在目录名末尾追加数字序号来区分。
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
每个目录下都有一个 brief.yaml 文件，包含此人的简介。
有些目录下还有一个 portrait.png 文件，对应此人的头像。
添加数据文件说明
2016-03-01 00:25:13 +08:00
* company
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
这个目录存放与太子党有关的公司或组织机构。目录结构与 person 类似。
添加数据文件说明
2016-03-01 00:25:13 +08:00
* family
这个目录存放家族关系的信息。每个家族是一个 yaml 格式的文件。
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
=== bin 目录 ===
该目录存放编译脚本。该脚本的使用参见下面的章节。
=== download 目录 ===
该目录存放制作好的文件，目前先提供 jpg 和 pdf 两种格式。
补充多人协作说明
2016-03-01 15:41:29 +08:00
如果你需要其它格式，可以用俺提供的编译脚本自行搞定（编译脚本的使用，参见下面的章节）。
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
== 编译脚本使用说明 ==
补充脚本使用说明
2016-03-01 11:39:15 +08:00
（俺是在 Linux 上编写该脚本，尚未在 Windows 上进行测试）
补充多人协作说明
2016-03-01 15:41:29 +08:00
如果你在 Windows 上使用碰到问题，可以到[https://program-think.blogspot.com/ 俺博客]留言进行反馈。也可以在[https://github.com/programthink/zhao/issues 本项目发一个 issue]。
补充脚本使用说明
2016-03-01 11:39:15 +08:00
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
=== 脚本的命令行参数 ===
添加数据文件说明
2016-03-01 00:25:13 +08:00
俺使用 python 作为编译脚本，该脚本位于 bin 目录下。
通过该脚本可以把原始数据生成为 dot 语言的脚本。然后再调用 Graphviz 把 dot 脚本生成各种格式（比如：pdf、jpeg）。
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
要使用该脚本，先在命令行模式下进入 bin 目录，然后运行如下命令：
（生成 pdf 格式的示例）
python make.py pdf
（生成 jpg 格式的示例）
python make.py jpg
=== 依赖的软件 ===
要使用上述脚本，你需要事先安装相关的软件（如下）
补充依赖软件说明
2016-03-01 16:59:51 +08:00
* Python2
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
因为俺用的是 Python 脚本，所有你需要先安装 python 软件。
Python 有两种版本——python2 和 python3——俺用的是 python2
补充依赖软件说明
2016-03-01 16:59:51 +08:00
* PyYAML
这是一个基于 python 开发的软件包，专门用来处理 YAML 格式的文件。
你需要在你的 python 环境中安装该软件包。其官方链接如下：
[http://pyyaml.org/wiki/PyYAML PyYAML 的官网的 wiki]
[https://pypi.python.org/pypi/PyYAML Python 官网的 PYPI]
补充目录说明和脚本使用说明
2016-03-01 09:47:08 +08:00
* Graphviz
这个软件是用来生成【关系图】的。关于该这个软件，俺已经写了一篇扫盲教程：
补充下载说明
2016-03-01 17:10:15 +08:00
添加数据文件说明
2016-03-01 00:25:13 +08:00
《[https://program-think.blogspot.com/2016/02/opensource-review-graphviz.html 开源项目：【自动】绘图工具Graphviz——《太子党关系网络》就是用它制作]》
添加项目简介
2016-02-28 23:57:41 +08:00