增加演示视频

Author: oldrev

README.md

@@ -28,6 +28,34 @@
 
 如果觉得项目有用，可以帮我点个星星，这对我非常有帮助。
 
+# 上手指南
+
+## 启动及运行
+
+首先通过命令行进入本项目根目录，通过 `npm` 安装依赖：
+
+```bash
+$> npm install 
+$> cd app
+$> npm install
+```
+
+开发模式运行：
+
+```bash
+$> npm start
+```
+
+构建可执行文件（构建结果根据当前操作系统而定）：
+```bash
+$> npm run electron:build
+```
+
+编译完成即可在 `./release` 中看到。
+
+## 关于演示视频
+
+演示视频在 `demo-video` 中，可以参考 `branchie-video.xml` 中的格式，具体请见介绍视频及源代码。
 
 # 版权
 
@@ -46,13 +74,14 @@
 
 ## 鸣谢
 
-没有如下开源项目的支持本项目不可能轻易实现，非常感谢：
+没有如下开源项目和素材的支持本项目不可能轻易实现，非常感谢：
 
 * 初始项目模板：[AngularElectron](https://img.shields.io/badge/maintained-yes-brightgreen)
 * [stateless]()
 * [toml-js]()
 * [xml2js]()
 * [`expression-eval`]()
+* [三连动画](https://www.bilibili.com/video/av96347968/)
 
 
 [maintained-badge]: https://img.shields.io/badge/maintained-yes-brightgreen

demo-video/branchie-video.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<branchie-video>
+
+	<activities>
+
+
+		<activity id="开始" video="start.mp4" start="true" />
+
+		<activity id="选择" video="选择.mp4" />
+
+		<activity id="三连" video="三连.mp4" score="1" />
+
+		<activity id="后腿" video="后腿.mp4" />
+
+		<activity id="喂食" video="喂食.mp4" score="2" />
+
+		<activity id="摸下巴" video="下巴.mp4" />
+
+		<activity id="握手" video="握手.mp4" />
+
+		<activity id="握手不开心" video="握手不开心.mp4" />
+
+		<activity id="好结局" video="好结局.mp4" end="true" />
+
+		<activity id="坏结局" video="坏结局.mp4" end="true" />
+
+
+	</activities>
+
+	<transitions>
+
+		<transition caption="先给个三连吧！" priority="0" from="开始" to="三连" />
+		<transition caption="下次一定" priority="0" from="开始" to="选择" />
+		<transition caption="自动跳转选择" priority="0" from="三连" to="选择" wait-signal="false" />
+
+		<transition caption="被迫营业结束" priority="0" from="好结局" to="开始" />
+		<transition caption="被迫营业结束" priority="0" from="坏结局" to="开始" />
+
+		<transition caption="先给我吃点儿！" priority="0" from="选择" to="喂食" if="fsm.totalScore < 2" />
+		<transition caption="吃完开始营业" priority="0" from="喂食" to="选择" />
+
+
+		<transition caption="摸摸下巴" priority="0" from="选择" to="摸下巴" />
+		<transition caption="营业结束" priority="0" from="摸下巴" to="好结局" if="fsm.totalScore > 0" wait-signal="false" />
+		<transition caption="营业结束" priority="0" from="摸下巴" to="坏结局" if="fsm.totalScore <= 0" wait-signal="false" />
+
+		<transition caption="摸摸后腿" priority="10" from="选择" to="后腿" />
+		<transition caption="营业结束" priority="0" from="后腿" to="好结局" if="fsm.totalScore > 0" wait-signal="false" />
+		<transition caption="营业结束" priority="0" from="后腿" to="坏结局" if="fsm.totalScore <= 0" wait-signal="false" />
+
+		<transition caption="握爪" priority="10" from="选择" to="握手" if="fsm.totalScore > 0" />
+		<transition caption="自动结束" priority="0" from="握手" to="好结局" if="fsm.totalScore > 0" wait-signal="false" />
+		<transition caption="自动结束" priority="0" from="握手" to="坏结局" if="fsm.totalScore <= 0" wait-signal="false" />
+
+		<transition caption="握爪" priority="10" from="选择" to="握手不开心" if="fsm.totalScore <= 0" />
+		<transition caption="自动结束" priority="0" from="握手不开心" to="坏结局" wait-signal="false" />
+
+	</transitions>
+
+
+</branchie-video>