From ca6e72d4fc5d391f4b8521209ff28b63a30c5003 Mon Sep 17 00:00:00 2001 From: Molunerfinn Date: Sat, 23 Dec 2017 20:20:30 +0800 Subject: [PATCH] Updated: readme --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c4c8dd4..dde253a3 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,39 @@ PicGo目前支持了`微博图床`,`七牛图床`,`腾讯云COS`,`又拍 ![picgo-menubar](https://user-images.githubusercontent.com/12621342/34242310-b5056510-e655-11e7-8568-60ffd4f71910.gif) -### 赞助 +## 开发说明 + +> 目前仅针对Mac平台。Windows和Linux平台并未测试。 + +如果你想要学习、开发、修改或自行构建PicGo,可以依照下面的指示: + +1. 你需要有node、git环境。需要了解npm的相关知识。 +2. `git clone https://github.com/Molunerfinn/PicGo.git` 并进入项目 +3. `npm install` 下载依赖 + +### 开发模式 + +输入`npm run dev`进入开发模式,开发模式具有热重载特性。不过需要注意的是,开发模式不稳定,会有进程崩溃的情况。此时需要: + +```bash +ctrl+c # 退出开发模式 +npm run dev # 重新进入开发模式 +``` + +### 生产模式 + +如果你需要自行构建,可以`npm run build`开始进行构建。构建成功后,会在`build`目录里出现构建成功的相应安装文件。 + +**注意**:如果你的网络环境不太好,可能会出现`electron-builder`下载`electron`二进制文件失败的情况。这个时候需要在`npm run build`之前指定一下`electron`的源为国内源: + +```bash +export ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/" +npm run build +``` + +只需第一次构建的时候指定一下国内源即可。后续构建不需要特地指定。二进制文件下载在`~/.electron/`目录下。如果想要更新`electron`构建版本,可以删除`~/.electron/`目录,然后重新运行上一步,让`electron-builder`去下载最新的`electron`二进制文件。 + +## 赞助 如果你喜欢PicGo并且它对你确实有帮助,欢迎给我打赏一杯咖啡的钱哈~