Skip to content

Commit

Permalink
更新说明
Browse files Browse the repository at this point in the history
  • Loading branch information
im3x-dev committed Nov 3, 2020
1 parent 09e79d6 commit 756dc45
Showing 1 changed file with 21 additions and 42 deletions.
63 changes: 21 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,35 @@
# 「小件件」开发框架

> iOS 小组件快速开发框架 / 模板 / 小组件源码 👉 for [Scriptable]()
> iOS 小组件快速开发框架 / 模板 / 小组件源码 👉 for [Scriptable]()
> [查看老版本(main分支)](tree/main)
## 为什么又开分支
`master` 分支太“专业性”了!
以至于不是那么好扩展和开发,比价适合喜欢折腾的 geek 极客们。
# 介绍
这是一个便于开发者在电脑上开发、测试、预览 iOS 小组件(Scriptable)的开发框架
通过简单安装,就可以获得一个舒适的Scriptable脚本开发环境,支持语法高亮、自动补全、实时同步测试预览。
不用再手机上敲代码了!并且该开发框架封装了很多常用的操作接口,大大节省小组件开发时间!

但我想,把这写用心编写的小组件,给更多的用户使用。
** 用户不必再琢磨输入什么参数,不用再去头疼修改什么代码,直接复制粘贴,长按桌面添加使用!**
# 开始
**首先,我们配置电脑开发环境:**
1. 下载安装 VSCode 编辑器
2. 下载本项目的此分支代码:`git clone -b v2-dev https://github.com/im3x/Scriptables.git` (⚠️注意要加`-b`参数指定分支)
3. 进入代码目录,安装依赖:`npm install`
4. 运行服务:`npm start`

所以,另开这个分支,也是一个全新的功能版本。
**然后,配置手机运行环境:**
1. 复制 [install-runtime.js](install-runtime.js) 脚本代码
2. 手机打开 `Scriptable` 应用,点击右上角➕,粘贴代码,点击运行
3. 如果成功,应该新加了两个插件文件:`「小件件」开发环境`、「`源码」小组件示例`
4. 点击 `「源码」小组件示例` 或者其他任何基于此框架开发的小组件,点击操作菜单的远程开发,即可链接电脑,开始远程编写体验!

## 分支介绍
`master` 分支采用的是远程加载的方案,对于网络和打算自定义的用户来说比较不方便。
`v2-dev` 分支,是一个利于开发者的框架,你可以 clone 这个项目到你的电脑,用 `VSCode` 打开编辑,用 `nodejs` 安装依赖并运行,然后就可以在手机上连接电脑,进行更快速的小组件开发体验了。

这个分支的仓库代码包含如下部分:

1. `「小件件」开发环境.js` 开发环境必备的模块,提供给小组件代码一些封装好的操作库和测试功能
2. `「小件件」小组件示例.js` 小组件示例代码,如果你是刚开始新建小组件,建议复制这个代码开始修改编写
3. `app.js` 开发环境服务端。 运行在你的电脑上
# 发布

你开发测试小组件完毕后,可以 `pull` 到本分支,小组件源码存放在 [Scrips](Scripts) 目录,你也可以手动复制其他的小组件进行修改使用。
微信小程序「小件件」 后续会开放开发者中心,开发者到时候可以上传、发布、出售自己的原创小组件。目前测试中,敬请关注!

## 安装开发环境
1. `git clone` 本分支代码到你的电脑
2. `npm install` 安装依赖环境
3. `npm start` 在 vscode 中运行服务

## 手机安装
复制 [install-runtime.js](install-runtime.js) 文件内容,手机打开 Scriptable 应用,点击+号新建,长按粘贴,点击运行即可

## 手机连接
分别复制 `「小件件」开发环境.js``「小件件」小组件示例.js` 源码到 `Scriptable` 应用里
我推荐的小组件命名: `「源码」小组件名`,这样当写的插件多了(打包后的和开发中的)就不容易混淆了

复制好后,请修改为对应的名字,比如`「小件件」开发环境.js` 代码保存成小组件,名称为:`「小件件」开发环境`
然后在 Scriptable 应用里点击`「小件件」小组件示例`,即可弹出开发操作菜单

点击【远程开发】,输入你的电脑的ip,即可连接上你的电脑编辑器
这时候,你就可以在编辑器上编写代码了(支持语法高亮、自动补全)
编写好了,进行保存,保存时手机会进行同步,并弹出预览小组件操作菜单,如果你不需要预览可以先忽略继续编辑。

编辑、预览测试没问题后,可点击【停止调试】关闭连接

## 发布小组件
(测试中)
小组件代码编写、测试没问题了,你可以选择开源,pull 到这个分支,也可以进行发布到「小件件」小程序
小程序开发者功能正在测试,开发者可以在上边发布自己的原创小组件,并可以进行付费出售等获取收入
开发中心后续会逐渐开放

交流群:
https://x.im3x.cn/images/qun1.jpeg
开发讨论交流群:https://x.im3x.cn/images/qun1.jpeg


![](https://x.im3x.cn/images/qr2.png)

0 comments on commit 756dc45

Please sign in to comment.