aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Chris Xiong <chirs241097@gmail.com> 2019-01-31 11:25:24 +0800
committerGravatar Chris Xiong <chirs241097@gmail.com> 2019-01-31 11:25:24 +0800
commitf3a42eea284ac7903f24ab8e29d9d7b355496019 (patch)
tree93bbd1b8f26086d92e9eed5c975a5df0ee3dd964 /README.md
downloadA-Peek-Into-Virtools-Scripting-f3a42eea284ac7903f24ab8e29d9d7b355496019.tar.xz
Initial commit. Preface and other basic stuff.
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1ee6b12
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Virtools 脚本指南
+## ——一个面向 Ballance 玩家的介绍
+
+### 简介
+
+这是一本向 Ballance 玩家介绍 Virtools 脚本指南的小册子。
+如果您对 Ballance 和 Virtools 两个名字均感到陌生,
+您可能需要重新思考您正在阅读这段文字的原因。
+
+这本小册子是一个开放的工程。欢迎任何人使用 GitHub 上的 Issue Tracker
+提出修改意见,或者发起 Pull Request 进行直接的修订。
+
+整个工程采用 CC BY-SA 4.0 协议授权。截图等材料中包含 Virtools S.A. (3DVIA)
+所持著作权的部分。本工程的作者相信这些材料用于该工程中属于「合理使用」
+的范围。
+
+### FAQ
+
+- 如何生成 PDF ?
+
+ 需要事先准备带有 CTeX 包的 TeX Live 软件。
+
+ 在工程根目录下执行 `xelatex main.tex` 即可生成可阅读的 `main.pdf`。
+
+- 如何贡献?
+
+ 所有人都可以使用 GitHub 的 Issue Tracker 提出修改意见。如果您了解 GitHub
+ 的基本工作流程,可以 fork 该工程,在做出更改之后发起 Pull Request 。
+
+- 为何使用 LaTeX ?
+
+ 传统的文档格式对版本控制系统不友好, Markdown 在排版方面又显得力不从心,
+ 故而选择了 LaTeX 。
+
+- 如何入门 TeX ?
+
+ [这里](https://zh.wikibooks.org/wiki/LaTeX)有一个相当不错的 LaTeX
+ 入门手册。