添加数据文件说明

README.wiki

@@ -1,12 +1,45 @@
 = 俺整理的《太子党关系网络》 =
 
+== 简介 ==
+
 此项目专门用来揭露天朝的权贵（也就是传说中的“赵家人”）。
 
 （2月29日）俺把收集这几年收集整理的数据开源到 GitHub，便于多人协作——大伙儿群策群力，一起来曝光权贵家族。
 
+
+== 数据格式说明 ==
+
+data 目录下存放原始的数据文件，全部采用[https://zh.wikipedia.org/wiki/YAML YAML 格式]。这种格式非常简洁明了，有利于完全不懂技术的网友参与编辑。
+
+而且俺在每一个 YAML 格式的文件中都写了详细的注释，便于其他网友修改。
+
 目前所有数据文件（YAML 格式）全部都上传了——总共700多个数据文件，对应700多人。
 
 另有200个头像。由于图片文件比较大，还没有上传。俺会在这一两天找个网速稳定的时候上传。
 
+== 数据目录说明 ==
+
+data 目录下另有三个子目录，分别如下：
+
+* person
+
+这个目录存放个人的资料，每个人一个目录，目录名就是人名。对于偶尔有同名的情况，在目录名末尾追加数字序号来区分。
+
+* company
+
+这个目录存放于太子党有关的公司或组织机构。目录结构与 person 类似。
+
+* family
+
+这个目录存放家族关系的信息。每个家族是一个 yaml 格式的文件。
+
+== 编译脚本说明 ==
+
+俺使用 python 作为编译脚本，该脚本位于 bin 目录下。
+
+通过该脚本可以把原始数据生成为 dot 语言的脚本。然后再调用 Graphviz 把 dot 脚本生成各种格式（比如：pdf、jpeg）。
+
+关于 Graphviz 这个软件，俺已经写了一篇扫盲教程：
+《[https://program-think.blogspot.com/2016/02/opensource-review-graphviz.html 开源项目：【自动】绘图工具Graphviz——《太子党关系网络》就是用它制作]》