From 315f4b87cc12fb477516cd2d12c007f608a7b348 Mon Sep 17 00:00:00 2001 From: programthink Date: Tue, 1 Mar 2016 09:47:08 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A1=A5=E5=85=85=E7=9B=AE=E5=BD=95=E8=AF=B4?= =?UTF-8?q?=E6=98=8E=E5=92=8C=E8=84=9A=E6=9C=AC=E4=BD=BF=E7=94=A8=E8=AF=B4?= =?UTF-8?q?=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.wiki | 55 +++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 45 insertions(+), 10 deletions(-) diff --git a/README.wiki b/README.wiki index 214b36d..0841a52 100644 --- a/README.wiki +++ b/README.wiki @@ -4,42 +4,77 @@ 此项目专门用来揭露天朝的权贵（也就是传说中的“赵家人”）。 -（2月29日）俺把收集这几年收集整理的数据开源到 GitHub，便于多人协作——大伙儿群策群力，一起来曝光权贵家族。 +（2月29日）俺把这几年收集整理的数据开源到 GitHub，便于多人协作——大伙儿群策群力，一起来曝光权贵家族。 +目前收集的资料——包括700多个数据文件（对应700多人），另有200多张图片（人物头像）。 == 数据格式说明 == -data 目录下存放原始的数据文件，全部采用[https://zh.wikipedia.org/wiki/YAML YAML 格式]。这种格式非常简洁明了，有利于完全不懂技术的网友参与编辑。 +本项目的数据文件，全部采用[https://zh.wikipedia.org/wiki/YAML YAML 格式]。这种格式非常简洁明了，有利于完全不懂技术的网友参与编辑。 而且俺在每一个 YAML 格式的文件中都写了详细的注释，便于其他网友修改。 -目前所有数据文件（YAML 格式）全部都上传了——总共700多个数据文件，对应700多人。 +== 目录说明 == -另有200个头像。由于图片文件比较大，还没有上传。俺会在这一两天找个网速稳定的时候上传。 +=== data 目录 == -== 数据目录说明 == - -data 目录下另有三个子目录，分别如下： +data 目录用来保存数据文件，该目录下另有如下三个子目录： * person 这个目录存放个人的资料，每个人一个目录，目录名就是人名。对于偶尔有同名的情况，在目录名末尾追加数字序号来区分。 +每个目录下都有一个 brief.yaml 文件，包含此人的简介。 + +有些目录下还有一个 portrait.png 文件，对应此人的头像。 + * company -这个目录存放于太子党有关的公司或组织机构。目录结构与 person 类似。 +这个目录存放与太子党有关的公司或组织机构。目录结构与 person 类似。 * family 这个目录存放家族关系的信息。每个家族是一个 yaml 格式的文件。 -== 编译脚本说明 == +=== bin 目录 === + +该目录存放编译脚本。该脚本的使用参见下面的章节。 + +=== download 目录 === + +该目录存放制作好的文件，目前先提供 jpg 和 pdf 两种格式。 + +== 编译脚本使用说明 == + +=== 脚本的命令行参数 === 俺使用 python 作为编译脚本，该脚本位于 bin 目录下。 通过该脚本可以把原始数据生成为 dot 语言的脚本。然后再调用 Graphviz 把 dot 脚本生成各种格式（比如：pdf、jpeg）。 -关于 Graphviz 这个软件，俺已经写了一篇扫盲教程： +要使用该脚本，先在命令行模式下进入 bin 目录，然后运行如下命令： + +（生成 pdf 格式的示例） + +python make.py pdf + +（生成 jpg 格式的示例） + +python make.py jpg + +=== 依赖的软件 === + +要使用上述脚本，你需要事先安装相关的软件（如下） + +* Python + +因为俺用的是 Python 脚本，所有你需要先安装 python 软件。 + +Python 有两种版本——python2 和 python3——俺用的是 python2 + +* Graphviz + +这个软件是用来生成【关系图】的。关于该这个软件，俺已经写了一篇扫盲教程： 《[https://program-think.blogspot.com/2016/02/opensource-review-graphviz.html 开源项目：【自动】绘图工具Graphviz——《太子党关系网络》就是用它制作]》