📝 Docs: update README

This commit is contained in:
Haoshen Zhong 2019-09-11 09:25:01 +08:00 committed by PiEgg
parent f21940ef23
commit f491209bd6

View File

@ -1,11 +1,7 @@
# PicGo <div align="center">
> 图片上传+管理新体验
<p align="center">
<img src="https://raw.githubusercontent.com/Molunerfinn/test/master/picgo/New%20LOGO-150.png" alt=""> <img src="https://raw.githubusercontent.com/Molunerfinn/test/master/picgo/New%20LOGO-150.png" alt="">
</p> <h1>PicGo</h1>
<p align="center"> <blockquote>图片上传+管理新体验 </blockquote>
<a href="https://github.com/feross/standard"> <a href="https://github.com/feross/standard">
<img src="https://img.shields.io/badge/code%20style-standard-green.svg?style=flat-square" alt=""> <img src="https://img.shields.io/badge/code%20style-standard-green.svg?style=flat-square" alt="">
</a> </a>
@ -21,47 +17,47 @@
<a href="https://github.com/PicGo/bump-version"> <a href="https://github.com/PicGo/bump-version">
<img src="https://img.shields.io/badge/picgo-convention-blue.svg?style=flat-square" alt=""> <img src="https://img.shields.io/badge/picgo-convention-blue.svg?style=flat-square" alt="">
</a> </a>
</p> </div>
## 应用说明 ## 应用说明
**PicGo在上传图片之后自动会将图片链接复制到你的剪贴板里可选5种复制的链接格式。** **PicGo 在上传图片之后自动会将图片链接复制到你的剪贴板里,可选 5 种复制的链接格式。**
PicGo目前支持了 PicGo 目前支持了
- ~~`微博图床` v1.0~~ **微博图床从2019年4月开始进行防盗链不建议继续使用** - ~~`微博图床` v1.0~~ **微博图床从 2019 4 月开始进行防盗链,不建议继续使用**
- `七牛图床` v1.0 - `七牛图床` v1.0
- `腾讯云COS v4\v5版本` v1.1 & v1.5.0 - `腾讯云 COS v4\v5版本` v1.1 & v1.5.0
- `又拍云` v1.2.0 - `又拍云` v1.2.0
- `GitHub` v1.5.0 - `GitHub` v1.5.0
- `SM.MS` v1.5.1 - `SM.MS` v1.5.1
- `阿里云OSS` v1.6.0 - `阿里云 OSS` v1.6.0
- `Imgur` v1.6.0 - `Imgur` v1.6.0
**本体不再增加默认的图床支持。你可以自行开发第三方图床插件。详见[PicGo-Core](https://picgo.github.io/PicGo-Core-Doc/)**。 **本体不再增加默认的图床支持。你可以自行开发第三方图床插件。详见 [PicGo-Core](https://picgo.github.io/PicGo-Core-Doc/)**。
第三方插件以及使用了PicGo底层的应用可以在[Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo)看到。欢迎贡献! 第三方插件以及使用了 PicGo 底层的应用可以在 [Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo) 找到。欢迎贡献!
支持macOS、windows 64位>= v1.3.1linux>= v1.6.0)。 PicGo 支持 macOS、Windows 64位>= v1.3.1Linux>= v1.6.0)。
支持快捷键`command+shift+p`macOS或者`control+shift+p`windows\linux用以支持快捷上传剪贴板里的图片第一张 支持快捷键`command+shift+p`macOS或者`control+shift+p`Windows\Linux用以支持快捷上传剪贴板里的图片第一张
PicGo支持自定义快捷键使用方法见[配置手册](https://picgo.github.io/PicGo-Doc/zh/guide/config.html)。 PicGo 支持自定义快捷键,使用方法见[配置手册](https://picgo.github.io/PicGo-Doc/zh/guide/config.html)。
开发进度可以查看[Projects](https://github.com/Molunerfinn/PicGo/projects),会同步更新开发进度。 开发进度可以查看 [Projects](https://github.com/Molunerfinn/PicGo/projects),会同步更新开发进度。
**如果第一次使用,请参考应用使用[快速上手](https://picgo.github.io/PicGo-Doc/zh/guide/getting-started.html)。遇到问题了还可以看看[FAQ](https://github.com/Molunerfinn/PicGo/blob/dev/FAQ.md)以及被关闭的[issues](https://github.com/Molunerfinn/PicGo/issues?q=is%3Aissue+is%3Aclosed)。** **如果第一次使用,请参考应用使用[快速上手](https://picgo.github.io/PicGo-Doc/zh/guide/getting-started.html)。遇到问题了还可以看看 [FAQ](https://github.com/Molunerfinn/PicGo/blob/dev/FAQ.md) 以及被关闭的 [issues](https://github.com/Molunerfinn/PicGo/issues?q=is%3Aissue+is%3Aclosed)。**
## 下载安装 ## 下载安装
点击此处下载[应用](https://github.com/Molunerfinn/PicGo/releases)。 点击此处下载[应用](https://github.com/Molunerfinn/PicGo/releases)。
macOS用户请下载最新版本的`dmg`文件windows用户请下载最新版本的`exe`文件linux用户请下载`AppImage`文件。 macOS 用户请下载最新版本的 `dmg` 文件Windows 用户请下载最新版本的 `exe` 文件Linux用户请下载 `AppImage` 文件。
**如果你是Arch类的Linux用户可以直接通过`aurman -S picgo-appimage`来安装PicGo。感谢 @houbaron 的贡献!** **如果你是 Arch 类的 Linux 用户,可以直接通过 `aurman -S picgo-appimage` 来安装 PicGo。感谢 @houbaron 的贡献!**
**如果你是macOS用户可以使用brew cask来安装PicGo: `brew cask install picgo`。感谢 @womeimingzi11 的贡献!** **如果你是 macOS 用户,可以使用 `brew cask` 来安装 PicGo: `brew cask install picgo`。感谢 @womeimingzi11 的贡献!**
**如果你是Windows用户还可以使用 [Scoop](https://scoop.sh/) 来安装PicGo: `scoop bucket add helbing https://github.com/helbing/scoop-bucket` & `scoop install picgo`。 感谢 @helbing 的贡献!** **如果你是 Windows 用户,还可以使用 [Scoop](https://scoop.sh/) 来安装 PicGo: `scoop bucket add helbing https://github.com/helbing/scoop-bucket` & `scoop install picgo`。 感谢 @helbing 的贡献!**
## 应用截图 ## 应用截图
@ -71,20 +67,20 @@ macOS用户请下载最新版本的`dmg`文件windows用户请下载最新版
## 开发说明 ## 开发说明
> 目前仅针对Mac、Windows。Linux平台并未测试。 > 目前仅针对 Mac、Windows。Linux 平台并未测试。
如果你想要学习、开发、修改或自行构建PicGo可以依照下面的指示 如果你想要学习、开发、修改或自行构建 PicGo可以依照下面的指示
> 如果想学习Electron-vue的开发可以查看我写的系列教程——[Electron-vue开发实战](https://molunerfinn.com/tags/Electron-vue/) > 如果想学习 Electron-vue 的开发,可以查看我写的系列教程——[Electron-vue 开发实战](https://molunerfinn.com/tags/Electron-vue/)
1. 你需要有node、git环境。需要了解npm的相关知识。 1. 你需要有 Node、Git环境了解 npm 的相关知识。
2. `git clone https://github.com/Molunerfinn/PicGo.git` 并进入项目 2. `git clone https://github.com/Molunerfinn/PicGo.git` 并进入项目
3. `npm install` 下载依赖 3. `npm install` 下载依赖
4. Mac需要有Xcode环境Windows需要有VS环境。 4. Mac 需要有 Xcode 环境Windows 需要有 VS 环境。
### 开发模式 ### 开发模式
输入`npm run dev`进入开发模式,开发模式具有热重载特性。不过需要注意的是,开发模式不稳定,会有进程崩溃的情况。此时需要: 输入 `npm run dev` 进入开发模式,开发模式具有热重载特性。不过需要注意的是,开发模式不稳定,会有进程崩溃的情况。此时需要:
```bash ```bash
ctrl+c # 退出开发模式 ctrl+c # 退出开发模式
@ -93,9 +89,9 @@ npm run dev # 重新进入开发模式
### 生产模式 ### 生产模式
如果你需要自行构建,可以`npm run build`开始进行构建。构建成功后,会在`build`目录里出现构建成功的相应安装文件。 如果你需要自行构建,可以 `npm run build` 开始进行构建。构建成功后,会在 `build` 目录里出现构建成功的相应安装文件。
**注意**:如果你的网络环境不太好,可能会出现`electron-builder`下载`electron`二进制文件失败的情况。这个时候需要在`npm run build`之前指定一下`electron`的源为国内源: **注意**:如果你的网络环境不太好,可能会出现 `electron-builder` 下载 `electron` 二进制文件失败的情况。这个时候需要在 `npm run build` 之前指定一下 `electron` 的源为国内源:
```bash ```bash
export ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/" export ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/"
@ -103,15 +99,15 @@ export ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/"
npm run build npm run build
``` ```
只需第一次构建的时候指定一下国内源即可。后续构建不需要特地指定。二进制文件下载在`~/.electron/`目录下。如果想要更新`electron`构建版本,可以删除`~/.electron/`目录,然后重新运行上一步,让`electron-builder`去下载最新的`electron`二进制文件。 只需第一次构建的时候指定一下国内源即可。后续构建不需要特地指定。二进制文件下载在 `~/.electron/` 目录下。如果想要更新 `electron` 构建版本,可以删除 `~/.electron/` 目录,然后重新运行上一步,让 `electron-builder `去下载最新的 `electron` 二进制文件。
## 其他相关 ## 其他相关
- [vs-picgo](https://github.com/Spades-S/vs-picgo)picgo的VSCode版。 - [vs-picgo](https://github.com/Spades-S/vs-picgo)PicGo 的 VS Code 版。
## 赞助 ## 赞助
如果你喜欢PicGo并且它对你确实有帮助欢迎给我打赏一杯咖啡哈~ 如果你喜欢 PicGo 并且它对你确实有帮助,欢迎给我打赏一杯咖啡哈~
支付宝: 支付宝: