📝 Docs(custom): update readme, prepare for 3.0.0

This commit is contained in:
Kuingsmile
2025-08-13 16:16:31 +08:00
parent c04fedc40d
commit 10eec5620c
9 changed files with 58 additions and 24 deletions

View File

@@ -40,7 +40,10 @@
- [Scoop (Windows)](#scoop-windows) - [Scoop (Windows)](#scoop-windows)
- [Winget (Windows)](#winget-windows) - [Winget (Windows)](#winget-windows)
- [Homebrew (macOS)](#homebrew-macos) - [Homebrew (macOS)](#homebrew-macos)
- [Mac Special Instructions](#mac-special-instructions) - [OS Requirements](#os-requirements)
- [Windows](#windows)
- [macOS](#macos)
- [Linux](#linux)
- [Screenshots](#screenshots) - [Screenshots](#screenshots)
- [Development](#development) - [Development](#development)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
@@ -139,6 +142,7 @@ Alternatively, install PicList-core with `npm install piclist` and set the uploa
#### Using docker run #### Using docker run
```bash ```bash
docker pull kuingsmile/piclist:latest
docker run -d \ docker run -d \
--name piclist \ --name piclist \
--restart always \ --restart always \
@@ -226,24 +230,39 @@ brew install piclist --cask
brew uninstall piclist brew uninstall piclist
``` ```
### Mac Special Instructions ### OS Requirements
If you encounter "file is damaged" messages or have issues opening on macOS, upgrade to PicList V1.4.1 or above. All Mac installation packages since V1.4.1 are signed with a developer certificate and won't trigger "malicious software" warnings. #### Windows
- **Supported Versions**: Windows 10 and later
- **Architectures**: `ia32` (x86), `x64` (amd64), `arm64`
#### macOS
- **Supported Versions**: macOS Big Sur (11) and later
- **Architectures**: Intel (x64) and Apple Silicon (arm64)
#### Linux
- **Supported Versions**:
- Ubuntu 18.04 and later
- Fedora 32 and later
- Debian 10 and later
## Screenshots ## Screenshots
![Upload interface](https://github.com/Kuingsmile/PicList/assets/96409857/1b76c0c4-753c-4d66-aa24-f805f9c2da15) ![Upload interface](./imgs/upload.png)
![Album view](https://github.com/Kuingsmile/PicList/assets/96409857/56cf838a-a2eb-40af-96d4-1ffea25400af) ![Album view](./imgs/gallery.png)
![Cloud management](https://github.com/Kuingsmile/PicList/assets/96409857/bca7688a-e07f-4e80-9edd-c224298fa8ab) ![Cloud management](./imgs/cloud_storage.png)
![Settings](https://github.com/Kuingsmile/PicList/assets/96409857/3e48e03d-b0b2-49e2-92a6-a52e0884677d) ![Settings](./imgs/settings.png)
![Image editing](https://github.com/Kuingsmile/PicList/assets/96409857/29de0046-1aef-4b28-95a6-b26c6e297c6f) ![Image editing](./imgs/image_editing.png)
![File preview](https://github.com/Kuingsmile/PicList/assets/96409857/e1c04488-2d3a-4e8f-aa26-ce41d0a383e2) ![Dark theme](./imgs/dark.png)
## Development ## Development
### Prerequisites ### Prerequisites
1. Node.js and Git environment 1. Node.js 20 + and Git
2. Knowledge of npm 2. Knowledge of npm
3. Xcode for Mac or Visual Studio for Windows 3. Xcode for Mac or Visual Studio for Windows

View File

@@ -40,7 +40,10 @@
- [ScoopWindows](#scoopwindows) - [ScoopWindows](#scoopwindows)
- [Winget (Windows)](#winget-windows) - [Winget (Windows)](#winget-windows)
- [HomebrewmacOS](#homebrewmacos) - [HomebrewmacOS](#homebrewmacos)
- [Mac特殊说明](#mac特殊说明) - [系统版本要求](#系统版本要求)
- [Windows](#windows)
- [macOS](#macos)
- [Linux](#linux)
- [应用截图](#应用截图) - [应用截图](#应用截图)
- [开发说明](#开发说明) - [开发说明](#开发说明)
- [前提条件](#前提条件) - [前提条件](#前提条件)
@@ -140,6 +143,7 @@ Windows系统
#### 使用docker run命令 #### 使用docker run命令
```bash ```bash
docker pull kuingsmile/piclist:latest
docker run -d \ docker run -d \
--name piclist \ --name piclist \
--restart always \ --restart always \
@@ -227,26 +231,39 @@ brew install piclist --cask
brew uninstall piclist brew uninstall piclist
``` ```
### Mac特殊说明 ### 系统版本要求
如果macOS系统安装PicList后显示"文件已损坏"或安装后打开无响应请升级到PicList V1.4.1或以上版本。 #### Windows
V1.4.1之后所有mac安装包都已使用开发者证书签名不会被macOS系统识别为"恶意软件",不会出现"文件已损坏"提示。 - **支持的版本**: Windows 10及以上版本
- **架构**: `ia32` (x86), `x64` (amd64), `arm64`
#### macOS
- **支持的版本**: macOS Big Sur (11)及以上
- **架构**: Intel (x64)和Apple Silicon (arm64)
#### Linux
- **包括不限于**:
- Ubuntu 18.04及更新版本
- Fedora 32及更新版本
- Debian 10及更新版本
## 应用截图 ## 应用截图
![上传界面](https://github.com/Kuingsmile/PicList/assets/96409857/1b76c0c4-753c-4d66-aa24-f805f9c2da15) ![上传界面](./imgs/upload.png)
![相册视图](https://github.com/Kuingsmile/PicList/assets/96409857/56cf838a-a2eb-40af-96d4-1ffea25400af) ![相册视图](./imgs/gallery.png)
![云存储管理](https://github.com/Kuingsmile/PicList/assets/96409857/bca7688a-e07f-4e80-9edd-c224298fa8ab) ![云存储管理](./imgs/cloud_storage.png)
![设置页面](https://github.com/Kuingsmile/PicList/assets/96409857/3e48e03d-b0b2-49e2-92a6-a52e0884677d) ![设置页面](./imgs/settings.png)
![图像编辑](https://github.com/Kuingsmile/PicList/assets/96409857/29de0046-1aef-4b28-95a6-b26c6e297c6f) ![图像编辑](./imgs/image_editing.png)
![文件预览](https://github.com/Kuingsmile/PicList/assets/96409857/e1c04488-2d3a-4e8f-aa26-ce41d0a383e2) ![深色主题](./imgs/dark.png)
## 开发说明 ## 开发说明
### 前提条件 ### 前提条件
1. 需要Node.jsGit环境 1. 需要Node.js 20+ 和 Git
2. 了解npm相关知识 2. 了解npm相关知识
3. Mac需要Xcode环境Windows需要Visual Studio环境 3. Mac需要Xcode环境Windows需要Visual Studio环境

BIN
imgs/cloud_storage.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

BIN
imgs/dark.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

BIN
imgs/gallery.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

BIN
imgs/image_editing.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

BIN
imgs/settings.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

BIN
imgs/upload.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

View File

@@ -174,9 +174,7 @@ class LifeCycle {
#onReady () { #onReady () {
const readyFunction = async () => { const readyFunction = async () => {
if (process.env.NODE_ENV !== 'production') { if (process.env.NODE_ENV !== 'production') {
installExtension(VUEJS_DEVTOOLS).then(name => { installExtension(VUEJS_DEVTOOLS).catch(err => {
console.log(`Added Extension: ${JSON.stringify(name)}`)
}).catch(err => {
console.log('An error occurred: ', err) console.log('An error occurred: ', err)
}) })
} }