zhao/README.wiki

87 lines
2.7 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
2月29日俺把这几年收集整理的数据开源到 GitHub便于多人协作——大伙儿群策群力一起来曝光权贵家族。
2016-03-01 00:10:08 +08:00
目前收集的资料——包括700多个数据文件对应700多人另有200多张图片人物头像
2016-03-01 00:25:13 +08:00
== 下载说明 ==
想要下载的同学,请直接进入 download 目录。
该目录下另有若干子目录,以【文件类型】区分。
2016-03-01 00:25:13 +08:00
== 数据格式说明 ==
本项目的数据文件,全部采用[https://zh.wikipedia.org/wiki/YAML YAML 格式]。这种格式非常简洁明了,有利于完全不懂技术的网友参与编辑。
2016-03-01 00:25:13 +08:00
而且俺在每一个 YAML 格式的文件中都写了详细的注释,便于其他网友修改。
== 目录说明 ==
2016-03-01 00:10:08 +08:00
=== data 目录 ===
2016-03-01 00:10:08 +08:00
data 目录用来保存数据文件,该目录下另有如下三个子目录:
2016-03-01 00:25:13 +08:00
* person
这个目录存放个人的资料,每个人一个目录,目录名就是人名。对于偶尔有同名的情况,在目录名末尾追加数字序号来区分。
每个目录下都有一个 brief.yaml 文件,包含此人的简介。
有些目录下还有一个 portrait.png 文件,对应此人的头像。
2016-03-01 00:25:13 +08:00
* company
这个目录存放与太子党有关的公司或组织机构。目录结构与 person 类似。
2016-03-01 00:25:13 +08:00
* family
这个目录存放家族关系的信息。每个家族是一个 yaml 格式的文件。
=== bin 目录 ===
该目录存放编译脚本。该脚本的使用参见下面的章节。
=== download 目录 ===
该目录存放制作好的文件,目前先提供 jpg 和 pdf 两种格式。
== 编译脚本使用说明 ==
=== 脚本的命令行参数 ===
2016-03-01 00:25:13 +08:00
俺使用 python 作为编译脚本,该脚本位于 bin 目录下。
通过该脚本可以把原始数据生成为 dot 语言的脚本。然后再调用 Graphviz 把 dot 脚本生成各种格式比如pdf、jpeg
要使用该脚本,先在命令行模式下进入 bin 目录,然后运行如下命令:
(生成 pdf 格式的示例)
python make.py pdf
(生成 jpg 格式的示例)
python make.py jpg
=== 依赖的软件 ===
要使用上述脚本,你需要事先安装相关的软件(如下)
* Python
因为俺用的是 Python 脚本,所有你需要先安装 python 软件。
Python 有两种版本——python2 和 python3——俺用的是 python2
* Graphviz
这个软件是用来生成【关系图】的。关于该这个软件,俺已经写了一篇扫盲教程:
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