Update Documents;

This commit is contained in:
Saturneric 2021-07-12 17:32:14 +08:00
parent 4ada913c51
commit be42e6149a
2 changed files with 39 additions and 40 deletions

View File

@ -5,7 +5,7 @@
![Language](https://img.shields.io/badge/language-C%2B%2B-green) ![Language](https://img.shields.io/badge/language-C%2B%2B-green)
![License](https://img.shields.io/badge/License-GPL--3.0-orange) ![License](https://img.shields.io/badge/License-GPL--3.0-orange)
![CodeSize](https://img.shields.io/github/languages/code-size/saturneric/GpgFrontend) ![CodeSize](https://img.shields.io/github/languages/code-size/saturneric/GpgFrontend)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d1750e052a85430a8f1f84e58a0fceda)](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/d1750e052a85430a8f1f84e58a0fceda)](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/saturneric/gpgfrontend) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/saturneric/gpgfrontend)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_small) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_small)
@ -30,7 +30,6 @@ If you find this tool useful and promising, welcome to encourage me through STAR
[>> 中文文档](https://github.com/saturneric/GpgFrontend/blob/main/README_CN.md) [>> 中文文档](https://github.com/saturneric/GpgFrontend/blob/main/README_CN.md)
<div align="center"> <div align="center">
<img width="640" src="https://github.com/saturneric/Blob/blob/master/screenshots/main_mac.jpg?raw=true" alt="macOS Screenshot"/> <img width="640" src="https://github.com/saturneric/Blob/blob/master/screenshots/main_mac.jpg?raw=true" alt="macOS Screenshot"/>
</div> </div>
@ -104,7 +103,7 @@ awesome operations.
1. [Download](https://gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.3.1_20210420.exe) `gnupg-w32-******.exe` 1. [Download](https://gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.3.1_20210420.exe) `gnupg-w32-******.exe`
2. Double Click it to install it 2. Double Click it to install it
3. [Download GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Windows Edition from the latest release 3. [Download GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Windows Edition from the latest release
4. Unzip `gpgfrontend-windows-latest-*******.zip` 4. Unzip `gpgfrontend-windows-latest-*******.zip`
5. Go into the directory and double click `GpgFrontend.exe`. 5. Go into the directory and double click `GpgFrontend.exe`.
@ -122,21 +121,21 @@ awesome operations.
1. Install gnupg (If you have already followed please skip) 1. Install gnupg (If you have already followed please skip)
- For Debian/Ubuntu - For Debian/Ubuntu
```shell ```shell
$ sudo apt update $ sudo apt update
$ sudo apt install gpg $ sudo apt install gpg
``` ```
- For CentOS - For CentOS
```shell ```shell
$ sudo yum install gnupg $ sudo yum install gnupg
``` ```
2. [Download GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Linux edition from the latest release 2. [Download GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Linux edition from the latest release
3. Unzip gpgfrontend-ubuntu-16.04-*******.zip 3. Unzip gpgfrontend-ubuntu-16.04-**\*\*\***.zip
- `ubuntu-16.04` shows that Linux distributions at the same time as 16.04 or later are supported. - `ubuntu-16.04` shows that Linux distributions at the same time as 16.04 or later are supported.
4. Give `GpgFrontend-***.AppImage` permission to execute 4. Give `GpgFrontend-***.AppImage` permission to execute
```shell ```shell
$ chmod u+x ./GpgFrontend-***.AppImage $ chmod u+x ./GpgFrontend-***.AppImage
``` ```
5. Just double-click `GpgFrontend-***.AppImage` to run it. 5. Just double-click `GpgFrontend-***.AppImage` to run it.
## Document ## Document

View File

@ -5,14 +5,14 @@
![Language](https://img.shields.io/badge/language-C%2B%2B-green) ![Language](https://img.shields.io/badge/language-C%2B%2B-green)
![License](https://img.shields.io/badge/License-GPL--3.0-orange) ![License](https://img.shields.io/badge/License-GPL--3.0-orange)
![CodeSize](https://img.shields.io/github/languages/code-size/saturneric/GpgFrontend) ![CodeSize](https://img.shields.io/github/languages/code-size/saturneric/GpgFrontend)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d1750e052a85430a8f1f84e58a0fceda)](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=saturneric/GpgFrontend&amp;utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/d1750e052a85430a8f1f84e58a0fceda)](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/saturneric/gpgfrontend) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/saturneric/gpgfrontend)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_small) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_small)
GpgFrontend 是一个易于使用、小巧、跨平台和免安装的 [OpenPGP](https://www.openpgp.org/) 加密解密签名工具。 GpgFrontend 是一个易于使用、小巧、跨平台和免安装的 [OpenPGP](https://www.openpgp.org/) 加密解密签名工具。
通过使用 GpgFrontend你可以快速加密和解密文本或文件。或者在进行上述操作的同时加上自己的签名让别人知道这个文件或者这段文字是出自你之手。 通过使用 GpgFrontend你可以快速加密和解密文本或文件。或者在进行上述操作的同时加上自己的签名让别人知道这个文件或者这段文字是出自你之手。
该软件旨在让普通用户更快上手gpg工具让专业用户更便捷。 GpgFrontend 支持 OpenPGP 的新特性。 该软件旨在让普通用户更快上手 gpg 工具,让专业用户更便捷。 GpgFrontend 支持 OpenPGP 的新特性。
注意GpgFrontend 不提供嵌入式 gnupg 二进制库,需要用户自行安装。这是为了确保安全,避免涉及加密解密的代码或二进制文件在传递过程中被植入后门。 注意GpgFrontend 不提供嵌入式 gnupg 二进制库,需要用户自行安装。这是为了确保安全,避免涉及加密解密的代码或二进制文件在传递过程中被植入后门。
@ -59,7 +59,7 @@ GpgFrontend 是一个易于使用、小巧、跨平台和免安装的 [OpenPGP](
- 开源,免费,无需安装。 - 开源,免费,无需安装。
- 只需双击即可自由使用。 - 只需双击即可自由使用。
- 支持多种语言。 - 支持多种语言。
- 有兴趣的可以帮我 [翻译一下界面](https://saturneric.github.io/GpgFrontend/index.html#/translate-interface) 。 - 有兴趣的可以帮我 [翻译一下界面](https://saturneric.github.io/GpgFrontend/index.html#/translate-interface) 。
## 使用方法 ## 使用方法
@ -91,40 +91,40 @@ GpgFrontend 是一个易于使用、小巧、跨平台和免安装的 [OpenPGP](
#### Windows #### Windows
1. [下载](https://gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.3.1_20210420.exe) gnupg-w32-******.exe 1. [下载](https://gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.3.1_20210420.exe) gnupg-w32-**\*\***.exe
2. 双击安装 2. 双击安装
3. [下载 GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Windows Edition from release 3. [下载 GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Windows Edition from release
4. 解压 gpgfrontend-windows-latest-*******.zip 4. 解压 gpgfrontend-windows-latest-**\*\*\***.zip
5. 进入目录,双击运行 GpgFrontend.exe 5. 进入目录,双击运行 GpgFrontend.exe
#### macOS #### macOS
0. 如果命令 `gpg` 不可用,请先用Homebrew安装它. 0. 如果命令 `gpg` 不可用,请先用 Homebrew 安装它.
1. [下载 GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) macOS edition from release 1. [下载 GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) macOS edition from release
2. 双击并加载 GpgFrontend.dmg 2. 双击并加载 GpgFrontend.dmg
3. 双击并运行 3. 双击并运行
(由于macOS的安全策略在真正能运行前请遵照系统说明). (由于 macOS 的安全策略,在真正能运行前请遵照系统说明).
4. 如果你满意的话可以将本软件复制到Application文件夹. 4. 如果你满意的话,可以将本软件复制到 Application 文件夹.
#### Debian/Ubuntu/CentOS #### Debian/Ubuntu/CentOS
1. 安装 gnupg (如果你已经安装了请跳过) 1. 安装 gnupg (如果你已经安装了请跳过)
- For Debian/Ubuntu - For Debian/Ubuntu
```shell ```shell
$ sudo apt update $ sudo apt update
$ sudo apt install gpg $ sudo apt install gpg
``` ```
- For CentOS - For CentOS
```shell ```shell
$ sudo yum install gnupg $ sudo yum install gnupg
``` ```
2. [下载 GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Linux edition from the latest release 2. [下载 GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Linux edition from the latest release
3. 解压 gpgfrontend-ubuntu-16.04-*******.zip 3. 解压 gpgfrontend-ubuntu-16.04-**\*\*\***.zip
- `ubuntu-16.04` 说明ubuntu 16.04及其同时期与后来的Linux发行版都可以正常运行。 - `ubuntu-16.04` 说明 ubuntu 16.04 及其同时期与后来的 Linux 发行版都可以正常运行。
4. 赋予 `GpgFrontend-***.AppImage` 执行权限 4. 赋予 `GpgFrontend-***.AppImage` 执行权限
```shell ```shell
$ chmod u+x ./GpgFrontend-***.AppImage $ chmod u+x ./GpgFrontend-***.AppImage
``` ```
5. 双击运行 `GpgFrontend-***.AppImage`. 5. 双击运行 `GpgFrontend-***.AppImage`.
## 文档 ## 文档
@ -136,14 +136,14 @@ GpgFrontend 是一个易于使用、小巧、跨平台和免安装的 [OpenPGP](
GpgFrontend 项目继承自一个相对成熟但未维护的 [gpg4usb](https://www.gpg4usb.org/) 项目。 GpgFrontend 项目继承自一个相对成熟但未维护的 [gpg4usb](https://www.gpg4usb.org/) 项目。
它继承了 gpg4usb 稳定、易用、小巧、免安装的特点。 它继承了 gpg4usb 稳定、易用、小巧、免安装的特点。
GpgFrontend 未来会增加更多功能提高GPG在端到端传输中的易用性并缩短密文长度。同时新功能的加入不影响旧的基础功能。 GpgFrontend 未来会增加更多功能,提高 GPG 在端到端传输中的易用性并缩短密文长度。同时,新功能的加入不影响旧的基础功能。
我个人的力量总是有限的。 GpgFrontend 欢迎志愿者加入。你可以使用 GitHub 平台提交问题或提交pull request。 我个人的力量总是有限的。 GpgFrontend 欢迎志愿者加入。你可以使用 GitHub 平台提交问题或提交 pull request。
GpgFrontend 项目作为开源项目,也坚持使用开源代码和库。 GpgFrontend 项目作为开源项目,也坚持使用开源代码和库。
## 构建方法 ## 构建方法
构建软件的教程将很快发布。你可以先查看本项目的GitHub Action文件。 构建软件的教程将很快发布。你可以先查看本项目的 GitHub Action 文件。
## 联系 ## 联系
@ -151,7 +151,7 @@ GpgFrontend 项目作为开源项目,也坚持使用开源代码和库。
### 做出贡献或者报告问题 ### 做出贡献或者报告问题
欢迎!你可以通过 [提出issue](https://github.com/saturneric/GpgFrontend/issues/new) 或提交 PR来做出贡献。 欢迎!你可以通过 [提出 issue](https://github.com/saturneric/GpgFrontend/issues/new) 或提交 PR 来做出贡献。
### 关于维护者 ### 关于维护者