first release now

fengshuo2004 · May 7, 2020 · 10db1f5 · 10db1f5
1 parent 97c853e
commit 10db1f5
Show file tree

Hide file tree

Showing 26 changed files with 1,289 additions and 15,515 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-/node_modules
+/node_modules
+/dist
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Scratch 3 到 HTML 转换器
 
+[![GitHub license](https://img.shields.io/github/license/fengshuo2004/SB3toHTML?style=flat-square)](https://github.com/fengshuo2004/SB3toHTML/blob/master/LICENSE)
+
 ## 总览
 
 SB3toHTML通过将一个Scratch项目连同所需的scratch虚拟机打包在一起，将这个项目转换成独立的单个html文件。
@@ -12,33 +14,46 @@ SB3toHTML通过将一个Scratch项目连同所需的scratch虚拟机打包在一
 
 我使用NodeJS Electron将此程序打包成Windows/MacOS/Linux执行档，还顺便对原本的用户界面进行了美观性打磨。
 
-## 开发
+## 构建
+
+> ⚠ 由于一些文件的引用方式，您必须先**构建**再调试！
 
-如果您想自己开发和构建本项目，您需要NodeJS环境和NPM包管理器。遵循以下步骤：
+如果您想自己开发和构建本项目，您需要Git命令行、NodeJS环境和NPM包管理器。遵循以下步骤：
 
 1. 用git克隆这个仓库到本地：
 
 ```bash
 git clone https://github.com/fengshuo2004/SB3toHTML.git
+cd SB3toHTML
 ```
 
 2. NPM安装需要的依赖：
 
 ```bash
-cd SB3toHTML
 npm install
 ```
 
-3. 启动Electron：
+3. 根据您的平台构建二进制：
 
 ```bash
-electron .
+npm run dist
 ```
-4. 完成！
+
+4. Electron-builder会在本目录下创建一个名为`dist`的文件夹，在里面构建二进制文件。不同系统会生成不同的目录，Windows系统是这样的：
+
+```
+📂 SB3toHTML (本目录)
+ → 📂 dist
+    → 📂 win-unpacked
+       → 📄 scratch3-packager.exe
+```
+
+5. 运行这个可执行文件即运行主程序
 
 ## 计划
 
-将来会支持这些新功能（按重要度从大到小排列)
+将来会支持这些新功能（按优先级从大到小排列)
 
 - [ ] 支持拖动文件进窗口作为sb3项目
-- [ ] 将分支更新到与SheepTester的Master平行，这会带来如连接到云变量服务器、加载中占位图等新功能
+- [ ] 给Windows安装程序添加签名
+- [ ] 将分支更新到与SheepTester的Master平行，这会带来如连接到云变量服务器、“加载中”占位图等新功能