diff options
author | Saturneric <[email protected]> | 2022-05-17 18:53:04 +0000 |
---|---|---|
committer | Saturneric <[email protected]> | 2022-05-17 18:53:04 +0000 |
commit | a0de038115525126d7538d91c358b13b3ae7280d (patch) | |
tree | 218984ed6978c50df3861414537ec2ef27e7cfd5 | |
parent | fix: solve dll export problem on inner class (diff) | |
download | GpgFrontend-a0de038115525126d7538d91c358b13b3ae7280d.tar.gz GpgFrontend-a0de038115525126d7538d91c358b13b3ae7280d.zip |
doc: update manual and readme
-rw-r--r-- | README.md | 4 | ||||
-rw-r--r-- | manual/_coverpage.md | 29 | ||||
-rw-r--r-- | manual/_navbar.md | 5 | ||||
-rw-r--r-- | manual/_sidebar.md | 2 | ||||
-rw-r--r-- | manual/download.md | 15 | ||||
-rw-r--r-- | manual/index.html | 11 | ||||
-rw-r--r-- | manual/manual/symmetric-encrypt-decrypt-text.md | 5 |
7 files changed, 44 insertions, 27 deletions
@@ -276,12 +276,8 @@ AppImage: https://appimage.org JSON for Modern C++: https://github.com/nlohmann/json -SMTP Client for Qt (C++): https://github.com/bluetiger9/SmtpClient-for-Qt - Qt-AES: https://github.com/saturneric/Qt-AES -vmime: https://www.vmime.org/ - MacOS Application Bundles: [Link](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html#//apple_ref/doc/uid/10000123i-CH101-SW1) diff --git a/manual/_coverpage.md b/manual/_coverpage.md index 53544d54..6717726b 100644 --- a/manual/_coverpage.md +++ b/manual/_coverpage.md @@ -1,33 +1,30 @@  # GpgFrontend - - - - +--- + + + [](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade) -**A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free [OpenPGP(pgp)](https://www.openpgp.org/) -Crypto Tool.** - -**Also, it's one of the excellent GUI Frontends for Modern GnuPG(gpg).** +- **A Free, Easy-to-Use, Cross-Platform [OpenPGP](https://www.openpgp.org/) Crypto Tool.** +- **One of the excellent GUI Frontends for Modern [GnuPG](https://gnupg.org/).** ## Brief Introduction -You can quickly make encrypted documents or email. - -You can digitally sign your text or documents. - -You can easily and intuitively manage all your keys on your computer. +- You can quickly make encrypted documents or text. +- You can digitally sign your text or documents. +- You can easily manage all your gpg keys on your computer. ## Features - Cross-Platform, can run on **Windows, Linux and macOS**. -- Open source, installation-free and free forever. -- Supports multiple languages. Languages spoken by most people in the world. +- Open source, Installation-free and Free forever. +- Supports multiple languages. -[Download](https://github.com/saturneric/GpgFrontend/releases/latest) +[Download](download.md) [Manual](overview.md) +[Document](https://doxygen.gpgfrontend.pub) <!-- 背景色 -->  diff --git a/manual/_navbar.md b/manual/_navbar.md index 050f600c..b93a35df 100644 --- a/manual/_navbar.md +++ b/manual/_navbar.md @@ -1,9 +1,8 @@ <!-- _navbar.md --> * [Source Code(Global CDN)](https://global.git.codesdream.com/GpgFrontend.git) -* [GitHub Repository](https://github.com/saturneric/GpgFrontend) -* [Developer Document](https://doxygen.gpgfrontend.pub) +* [Document](https://doxygen.gpgfrontend.pub) * [Manual](overview.md) -* [Download](https://github.com/saturneric/GpgFrontend/releases/latest) +* [Download](download.md) * [Contract](contract.md) diff --git a/manual/_sidebar.md b/manual/_sidebar.md index 26a39c9f..f6b7b2ea 100644 --- a/manual/_sidebar.md +++ b/manual/_sidebar.md @@ -5,7 +5,7 @@ - Manual - [Understand Interface](manual/understand-interface.md) - [Encrypt & Decrypt Text](manual/encrypt-decrypt-text.md) - - Symmetric Encrypt & Decrypt Text + - [Symmetric Encrypt & Decrypt Text](manual/symmetric-encrypt-decrypt-text.md) - [Sign & Verify Text](manual/sign-verify-text.md) - [Encrypt & Decrypt File](manual/encrypt-decrypt-file.md) - [Sign & Verify File](manual/sign-verify-file.md) diff --git a/manual/download.md b/manual/download.md new file mode 100644 index 00000000..501a265b --- /dev/null +++ b/manual/download.md @@ -0,0 +1,15 @@ +# Download GpgFrontend + +Currently you can download and use GpgFrontend through various channels. + +## GitHub + +[](https://github.com/saturneric/GpgFrontend/releases/latest) + +## SourgeForge + +[](https://sourceforge.net/projects/gogfrontend/files/latest/download) + +## Microsoft Store + +<ms-store-badge productid="9NH716MQK2B5" size="small"></ms-store-badge>
\ No newline at end of file diff --git a/manual/index.html b/manual/index.html index 2e07158b..57ca67e3 100644 --- a/manual/index.html +++ b/manual/index.html @@ -6,20 +6,23 @@ <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> <meta name="description" content="Description"> <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"> - <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"> + <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-defaults.css"> <link rel="shortcut icon" href="/_media/icon.svg" type="image/x-icon"> </head> <body> <div id="app"></div> <script> window.$docsify = { - logo: '/_media/trademark.png', - name: 'GpgFrontend', + search: 'auto', + logo: '/_media/trademark.png', + name: 'GpgFrontend', loadNavbar: true, loadSidebar: true, coverpage: true, onlyCover: true, subMaxLevel: 3, + repo: 'https://github.com/saturneric/GpgFrontend', + mergeNavbar: true, alias: { '/.*/_sidebar.md': '/_sidebar.md' } @@ -29,5 +32,7 @@ <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script> <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script> <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script> + <script src="//cdn.jsdelivr.net/npm/docsify-edit-on-github"></script> + <script type="module" src="https://getbadgecdn.azureedge.net/ms-store-badge.bundled.js"></script> </body> </html> diff --git a/manual/manual/symmetric-encrypt-decrypt-text.md b/manual/manual/symmetric-encrypt-decrypt-text.md new file mode 100644 index 00000000..fb469277 --- /dev/null +++ b/manual/manual/symmetric-encrypt-decrypt-text.md @@ -0,0 +1,5 @@ +# Symmetric Encrypt & Decrypt Text + +Symmetric encryption will be triggered when you click the Encrypt button and do not check any key in the Key Toolbox. +For symmetric encryption, you need to set a password for your encryption process. When decrypting, you need to enter +the same password as the encryption process.
\ No newline at end of file |