aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSaturneric <[email protected]>2021-12-13 16:59:04 +0000
committerSaturneric <[email protected]>2021-12-13 17:59:24 +0000
commitb43e37688757ab5f3f734e7392a37513f2692c41 (patch)
tree57bed013e208f37d8ca16eb5b290f9c11007b835 /README.md
parentImprove UI & Fixed. (diff)
downloadGpgFrontend-b43e37688757ab5f3f734e7392a37513f2692c41.tar.gz
GpgFrontend-b43e37688757ab5f3f734e7392a37513f2692c41.zip
Update Translations & README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md79
1 files changed, 38 insertions, 41 deletions
diff --git a/README.md b/README.md
index 85ac643c..cc855d60 100644
--- a/README.md
+++ b/README.md
@@ -9,31 +9,29 @@
![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)
-GpgFrontend is a Powerful, Easy-to-Use, Compact, Cross-Platform, and
-Installation-Free [OpenPGP](https://www.openpgp.org/)
+GpgFrontend is a Free, Open Source, Powerful, Easy-to-Use, Compact, Cross-Platform [OpenPGP](https://www.openpgp.org/)
Crypto Tool.
By using GpgFrontend, you can quickly encrypt and decrypt text or files. Or at the same time as the above operations,
you can add your own signature to let others know that this document or this paragraph of text was issued by you.
Please **take the initiative to protect privacy in your own hands**, instead of relying on servers and algorithms
-provided by large companies.
+provided by large companies. Please use this tool to transmit or store information that you regard as very precious. You
+can also use it to securely guarantee the authenticity of your information.
-**Notice:** GpgFrontend does not provide an embedded [gnupg](https://gnupg.org/) binary library and needs to be
-installed by the user. **This is to ensure safety and avoid code or binary files involved in encryption and decryption
-being implanted in the backdoor during the delivery process.**
+GpgFrontned [supports languages](#languages-support) that are widely used in most countries and regions around the
+world, including English, Chinese, French, Russian, German, Spanish, Portuguese, Arabic, etc.
+
+**Notice:** GpgFrontend does not provide an embedded [gnupg](https://gnupg.org/) (gpg) binary and needs to be installed
+by the user. **This is to ensure safety and avoid code or binary files involved in encryption and decryption being
+implanted in the backdoor during the delivery process.**
If you find this tool useful and promising, welcome to encourage me through STAR this project. Thanks!
[>> Quick Start <<](#quick-start) |
-[>> Code & Binary Security <<](https://gpgfrontend.pub/#/about/code-binary-verify) |
-[>> 简中README <<](https://github.com/saturneric/GpgFrontend/blob/main/README_CN.md)
+[>> Code & Binary Security <<](https://gpgfrontend.pub/#/about/code-binary-verify)
<div align="center">
-<img width="640" src="https://github.com/saturneric/Blob/blob/master/screenshots/main_mac.jpg?raw=true" alt="macOS Screenshot"/>
-</div>
-<div align="center">
-<img width="320" src="https://github.com/saturneric/Blob/blob/master/screenshots/key_info.PNG?raw=true" alt="Windows Screenshot"/>
-<img width="320" src="https://github.com/saturneric/Blob/blob/master/screenshots/keygen_ubuntu.png?raw=true" alt="Ubuntu Screenshot"/>
+<img src="https://github.com/saturneric/Blob/blob/master/screenshots/main-ubuntu.png?raw=true" alt="Ubuntu Main Screenshot"/>
</div>
#### Workflows Status:
@@ -44,7 +42,6 @@ If you find this tool useful and promising, welcome to encourage me through STAR
## Table of Contents
-- [Features](#features)
- [Usage](#usage)
- [Quick Start](#quick-start)
- [How to Run it](#how-to-run-it)
@@ -60,13 +57,6 @@ If you find this tool useful and promising, welcome to encourage me through STAR
- [Maintainers](#maintainers)
- [Licenses](#LICENSES)
-## Features
-
-- Can run on **Windows, Linux and macOS**.
-- Open source, free, no need to install.
-- Just double-click, and then you can use it freely.
-- Supports multiple [languages](#languages-support).
-
## Usage
### Quick Start
@@ -75,13 +65,13 @@ If you find this tool useful and promising, welcome to encourage me through STAR
Encryption can be done in just a few clicks.
-![GIF](https://github.com/saturneric/Blob/blob/master/gif/encrypt.gif?raw=true)
+![GIF](https://github.com/saturneric/Blob/blob/master/gif/encrypt-sign.gif?raw=true)
### Fast Text Decryption
I want to see what you wrote right away.
-![GIF](https://github.com/saturneric/Blob/blob/master/gif/decrypt.gif?raw=true)
+![GIF](https://github.com/saturneric/Blob/blob/master/gif/decrypt-verify.gif?raw=true)
### Fast File Encryption & Sign
@@ -95,7 +85,7 @@ Read the animated pictures in the [Document](https://gpgfrontend.pub/#/quick-sta
### How to Run it
-#### Windows
+#### Windows (No Setup)
0. If you haven't installed gnupg,
please [Download](https://gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.3.1_20210420.exe) `gnupg-w32-******.exe` and
@@ -104,9 +94,17 @@ Read the animated pictures in the [Document](https://gpgfrontend.pub/#/quick-sta
2. Unzip `gpgfrontend-windows-latest-*******.zip`
3. Go into the directory and double click `GpgFrontend.exe`.
+#### Windows (Setup)
+
+0. Double click `GpgFrontend-...-Setup.exe`.
+1. Use GpgFrontend.
+
#### macOS
0. If command `gpg` is not available, please use homebrew to install it first.
+ ```shell
+ $ sudo brew install gpg
+ ```
1. [Download GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) macOS edition from the latest release
2. Double-Click GpgFrontend.dmg to load it
3. Double click and run it
@@ -132,11 +130,11 @@ Read the animated pictures in the [Document](https://gpgfrontend.pub/#/quick-sta
```shell
$ chmod u+x ./GpgFrontend-***.AppImage
```
-3. Just double-click `GpgFrontend-***.AppImage` to run it.
+3. Just double-click `GpgFrontend-***.AppImage` to run it. (If you installed AppImage Launcher, it's better.)
## Document
-for more usage information, please read [document](https://gpgfrontend.pub/#/overview).
+For more usage information, please read [document](https://gpgfrontend.pub/#/overview).
## Purpose
@@ -162,17 +160,14 @@ The supported languages are listed here. Some languages use machine translation
to join translation and verification work, please refer to
the [translate the interface](https://gpgfrontend.pub/#/translate-interface).
-Notice: The verification may not be complete and rigorous.
+### Supported Languages
-| Language | English | 简体中文 | français | Французский | Español |
-| ---- | ---- | ---- | ---- | ---- | ---- |
-| Support | Support | 支持 | Etre prêt | ожидать | apoyar |
-| Verification | Origin | 不完全 | Jamais |Никогда | Nunca |
+'zh_CN', 'es_ES', 'zh_TW', 'zh_HK', 'fr_FR', 'de_DE', 'pl_PL', 'ru_RU', 'ja_JP', 'it_IT',
+'ko_KR', 'pt_BR', 'ar_SA', 'ar_IQ', 'hi_IN', 'af_ZA', 'sq_AL', 'be_BY', 'bg_BG', 'ca_ES',
+'hr_HR', 'cs_CZ', 'da_DK', 'nl_NL', 'et_EE', 'fa_IR', 'fi_FI', 'fr_CA', 'he_IL', 'id_ID',
+'lt_LT', 'De_AT', 'De_CH', 'El_GR', 'Es_MX', 'Iw_IL', 'UK_UA'
-| Language | 日本語 | 繁體中文 | عربى | português |
-| ---- | ---- | ---- | ---- | ---- |
-| Support | 未だに | 尚未 | ليس بعد | Ainda não |
-| Verification | | | | |
+Notice: The verification may not be complete and rigorous.
## Contract
@@ -201,19 +196,21 @@ GpgFrontend itself is licensed under the [GPLv3](COPYING).
There are some libraries and binary included in the zip-file which (may) have different licenses, for more information
check their homepages. You can also obtain the sources from there.
-gnupg: https://gnupg.org/
+gnupg: https://gnupg.org
+
+gpgme: https://gnupg.org/software/gpgme/index.html
-gpg4usb: https://www.gpg4usb.org/
+gpg4usb: https://www.gpg4usb.org
-QT 5.15.2(opensource): https://www.qt.io/
+QT 5.15.2(opensource): https://www.qt.io
-MSYS2: https://www.msys2.org/
+MSYS2: https://www.msys2.org
mingw-w64: http://mingw-w64.org/doku.php
-AppImage: https://appimage.org/
+AppImage: https://appimage.org
-rapidjson: https://github.com/Tencent/rapidjson
+JSON for Modern C++: https://github.com/nlohmann/json
Application
Bundles: [Link](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html#//apple_ref/doc/uid/10000123i-CH101-SW1)