GitHub 提供了“下载整个项目”的功能,但是会比较大。
首页上方点击进入 download 这个目录。
该目录下有 pdf 和 jpg 两个子目录,分别存放对应的 【文件类型】 。你想要看哪一种文件格式,就进入哪个子目录里面。
进入【文件类型】的子目录之后,会看到一个文件列表。先点击你想要的某个文件,会进入该文件的页面。
然后在【右上方】你会看到一个 Raw 按钮 ,在这个按钮上点【右键】,在【右键菜单】里面选“保存”或“另存为”,就可以把这个文件下载到你本机。
本项目的数据文件,全部采用YAML 格式。这种格式非常简洁明了,有利于完全不懂技术的网友参与编辑。
而且俺在每一个 YAML 格式的文件中都写了详细的注释,便于其他网友修改。
data 目录用来保存数据文件,该目录下另有如下三个子目录:
- person
每个目录下都有一个 brief.yaml 文件,包含此人的简介。
有些目录下还有一个 portrait.png 文件,对应此人的头像。
- company
- family
该目录存放编译脚本。该脚本的使用参见下面的章节。
该目录存放制作好的文件,目前先提供 jpg 和 pdf 两种格式。
如果你需要其它格式,可以用 bin 目录下的编译脚本自行搞定(编译脚本的使用,参见下面的章节)。
俺使用 python 作为编译脚本,该脚本位于 bin 目录下。
通过该脚本可以把原始数据生成为 dot 语言的脚本。然后再调用 Graphviz 把 dot 脚本生成各种格式(比如:pdf、jpeg)。
要使用该脚本,先在命令行模式下进入 bin 目录,然后运行如下命令:
(生成 pdf 格式的示例)
python make.py pdf
(生成 jpg 格式的示例)
python make.py jpg
要使用上述脚本,你需要事先安装相关的软件(如下)
- Python(2 或 3)
目前 Python 有两种大版本——python2 和 python3——编译脚本 【同时兼容】 这两种 Python 的大版本。
对于 Python 的小版本,俺本人在 2.7 和 3.5 上测试通过。2.6 和 3.4 估计也可以。
- PyYAML
你需要在你的 python 环境中安装该软件包。其官方链接如下:
- Graphviz