Skip to content

Commit

Permalink
一些零碎小说明
Browse files Browse the repository at this point in the history
  • Loading branch information
im3x-dev committed Nov 2, 2020
1 parent 3c94f9a commit cc7ad75
Showing 1 changed file with 49 additions and 6 deletions.
55 changes: 49 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,53 @@
# 「小件件」开发框架

> iOS 小组件快速开发框架+模板
> for [Scriptable]()
> iOS 小组件快速开发框架 / 模板 / 小组件源码 👉 for [Scriptable]()
## 简介
[Scriptable]() 是一款可以自定义 iOS 桌面小组件的 App。
这个框架可以让你快速便捷地在电脑上进行连接手机,并采用 `VSCode` 编辑器进行编写、测试小组件,支持语法高亮、自动补全等功能
## 为什么又开分支
`master` 分支太“专业性”了!
以至于不是那么好扩展和开发,比价适合折腾的geek群体

`「小件件」开发环境.js` 是基础开发库,开发小组件请采用 `「小件件」组件模板.js` 进行修改编写
但我想,把这写用心编写的小组件,给更多的用户使用。
用户不必再琢磨输入什么参数,不用再去头疼修改什么代码,直接复制粘贴,长按桌面添加使用!

所以,另开这个分支,也是一个全新的功能版本。

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

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

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


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

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

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

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

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

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

交流群:
https://x.im3x.cn/images/qun1.jpeg

小程序:
![](https://x.im3x.cn/images/qr.png)

0 comments on commit cc7ad75

Please sign in to comment.