Skip to content

Commit ce3b1d7

Browse files
committed
docs(readme): simplify and restructure documentation
* Streamlines feature descriptions for clarity and brevity * Reorganizes sections to improve navigation and developer onboarding * Moves developer and project origin info into new sections * Removes redundant details and outdated contact instructions Improves overall readability and accessibility for both users and contributors.
1 parent eab959f commit ce3b1d7

File tree

1 file changed

+53
-89
lines changed

1 file changed

+53
-89
lines changed

README.md

Lines changed: 53 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -7,75 +7,47 @@
77
[![Build Nightly](https://github.com/saturneric/GpgFrontend/actions/workflows/testing-nightly.yml/badge.svg?branch=develop)](https://github.com/saturneric/GpgFrontend/actions/workflows/testing-nightly.yml)
88
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/saturneric/GpgFrontend)
99

10-
A modern Enigma built on [GnuPG](https://www.gnupg.org/). It brings clarity,
11-
security, and trust to everyday encryption.
10+
A modern "Enigma" built on [GnuPG](https://www.gnupg.org/). It brings easy and
11+
trustworthy to your privacy life.
1212

1313
<img width="100" height="100" align="right" style="position: absolute;right: 0;padding: 12px;top:12px;z-index: 1000;" src="https://image.cdn.bktus.com/i/2024/02/24/248b2e18-a120-692e-e6bc-42ca30be9011.webp" alt="GpgFrontend"/>
1414

15-
**Key Features:**
16-
17-
- One-click encryption and signing: Quickly encrypt, decrypt and digitally sign
18-
texts, files and emails
19-
- Easy installation: Available via Homebrew, Flatpak, GitHub Releases, winget,
20-
AUR, Microsoft Store and more
21-
- True cross-platform experience: Native support for Windows, macOS and Linux;
22-
can also be built on FreeBSD
23-
- Fully portable: Run directly from a USB drive and move keys and settings
24-
between Windows and Linux without hassle
25-
- Secure key transfer: Safely migrate your keys and configurations across
26-
devices
27-
- Multiple independent key databases: Manage keys and identities separately for
28-
different roles, projects or teams
29-
- Comprehensive algorithm support: Includes RSA, DSA, EdDSA, ECDSA (NIST,
30-
Brainpool), ECDH and other algorithms via the latest GnuPG
31-
32-
> If you appreciate GpgFrontend, just give it a ⭐ on GitHub: it’s like adopting
33-
> your own little digital Enigma.
15+
**Key Features**
16+
17+
- Easy: Encrypt and sign your texts, files and more.
18+
- Cross-platform: Native support for Windows, macOS and Linux.
19+
- Portable: Run directly from a USB drive and carry your keys.
20+
- Flexible: Manage keys separately through multiple key databases.
21+
- Privacy-focused: Using multiple approaches to enhance safety.
22+
23+
> If you like GpgFrontend, you can give it a ⭐ on GitHub as donation. :)
3424
3525
## Table of Contents
3626

3727
- [GpgFrontend](#gpgfrontend)
3828
- [Table of Contents](#table-of-contents)
3929
- [User Manual](#user-manual)
40-
- [Developer Wiki](#developer-wiki)
41-
- [Language Support](#language-support)
42-
- [Supported Languages](#supported-languages)
30+
- [Supported Languages](#supported-languages)
4331
- [Modules](#modules)
44-
- [Mission and Origins](#mission-and-origins)
45-
- [Contact](#contact)
4632
- [Contributing \& Bugs Report](#contributing--bugs-report)
47-
- [Quick Start with GitHub Codespaces](#quick-start-with-github-codespaces)
48-
- [Project Maintainer](#project-maintainer)
33+
- [For Developers](#for-developers)
4934
- [Project's Logo](#projects-logo)
35+
- [Mission and Origins](#mission-and-origins)
36+
- [Project Maintainer](#project-maintainer)
5037
- [LICENSES](#licenses)
5138

5239
## User Manual
5340

5441
For detailed instructions on installation, usage, and troubleshooting, please
55-
refer to the official [User
56-
Manual](https://www.gpgfrontend.bktus.com/overview/glance). The User Manual is
57-
the primary and most up-to-date resource for all users. It provides
58-
comprehensive guidance beyond what is found in the README, ensuring you have the
59-
latest information and best practices.
42+
refer to the [User Manual](https://www.gpgfrontend.bktus.com/overview/glance).
43+
The User Manual is the primary and most up-to-date resource for all users. It
44+
provides guidance beyond what is found in the README, ensuring you have the best
45+
practices.
6046

6147
The source code for the user manual is maintained in this
6248
[repository](https://github.com/saturneric/GpgFrontend-Manual.git).
6349

64-
## Developer Wiki
65-
66-
[An AI-assisted Wiki](https://deepwiki.com/saturneric/GpgFrontend) has been
67-
generated through automated analysis of the GpgFrontend source code. This Wiki
68-
offers a comprehensive overview of the project’s technical architecture, design
69-
principles, and major components. It serves as a valuable resource for developers
70-
looking to understand the inner workings of GpgFrontend.
71-
72-
## Language Support
73-
74-
If you find an error in any of the translations or need to add a new one, we
75-
welcome you to [join our translation
76-
work](https://www.gpgfrontend.bktus.com/appendix/translate-interface).
77-
78-
### Supported Languages
50+
## Supported Languages
7951

8052
GpgFrontend currently supports an array of languages including:
8153

@@ -84,9 +56,14 @@ GpgFrontend currently supports an array of languages including:
8456
- French
8557
- German
8658
- Italian
59+
- Spanish
8760

8861
Contributors: [SHOW](TRANSLATORS)
8962

63+
If you find an error in any of the translations or need to add a new one, we
64+
welcome you to [join our translation
65+
work](https://www.gpgfrontend.bktus.com/appendix/translate-interface).
66+
9067
## Modules
9168

9269
GpgFrontend supports extensive module development, allowing users to customize
@@ -96,32 +73,6 @@ for guidance [Module
9673
Repository](https://github.com/saturneric/GpgFrontend-Modules.git) to reach a
9774
broader audience.
9875

99-
### Mission and Origins
100-
101-
GpgFrontend draws its inspiration and core philosophy from the stable, portable,
102-
and cross-platform **[gpg4usb](https://git.bktus.com/gpgfrontend/gpg4usb/)**
103-
project. Inheriting the spirit of true portability and platform independence,
104-
GpgFrontend builds on this foundation to deliver advanced features, modern
105-
cryptographic standards, and a clean, intuitive user experience.
106-
107-
As described in the article _[“The Past and Present of GpgFrontend: My Journey
108-
with an Open-Source Encryption
109-
Tool”](https://blog.bktus.com/en/archives/u8hywl/)_, the project began with a
110-
simple question:
111-
112-
> “What if everyone could have a small, reliable, and secure ‘crypto machine’—a
113-
> tool that makes encryption as tangible and trustworthy as turning a key in a
114-
> lock?”
115-
116-
That idea became the cornerstone of GpgFrontend’s mission: **to make OpenPGP
117-
encryption truly accessible—simple, robust, and convenient for everyone, on any
118-
major operating system.**
119-
120-
## Contact
121-
122-
Please refer to [HERE](https://www.gpgfrontend.bktus.com/overview/contact) for
123-
my contact details.
124-
12576
## Contributing & Bugs Report
12677

12778
Feel free to dive in! [Open an
@@ -132,28 +83,41 @@ to register, you are welcome to communicate with me via email.
13283

13384
[Contributing Guide](https://www.gpgfrontend.bktus.com/appendix/contribute)
13485

135-
### Quick Start with GitHub Codespaces
86+
### For Developers
13687

137-
[![Open in GitHub
138-
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/saturneric/GpgFrontend)
88+
GpgFrontend's architecture and design is not easy for starters, especially for
89+
developers who are not familiar with c++, qt and multi-threading. I was
90+
struggling hard for these in the past years as well. [An AI-assisted
91+
Wiki](https://deepwiki.com/saturneric/GpgFrontend) has been created through
92+
analysis of the GpgFrontend source code. This Wiki offers a comprehensive
93+
overview of the project’s technical architecture, design principles, and major
94+
components. I'd checked it and I would say that it can be of great help.
13995

140-
With just one click, you can quickly launch a fully configured development
141-
environment in GitHub Codespaces.
96+
For setting up the development environment, please refer to the [Development
97+
Environment Setup Guide](https://gpgfrontend.bktus.com/appendix/setup-dev-env).
14298

143-
## Project Maintainer
99+
## Project's Logo
144100

145-
[@Saturneric](https://github.com/saturneric)
101+
<img width="256" height="256" src="https://image.cdn.bktus.com/i/2024/02/24/f3f2f26a-96b4-65eb-960f-7ac3397a0a40.webp" alt="Logo"/>
146102

147-
I’m always eager to hear your suggestions for improvement. My goal is to
148-
continuously enhance the usability of GpgFrontend and address critical issues
149-
effectively. Your feedback is highly valued and has a great chance of being
150-
implemented in the next release. Feel free to share your ideas and insights via
151-
Issues, email, or any other convenient method. Together, we can make GpgFrontend
152-
even better!
103+
## Mission and Origins
153104

154-
## Project's Logo
105+
GpgFrontend inherits the codebase from the discontinued but easy-to-use
106+
**[gpg4usb](https://git.bktus.com/gpgfrontend/gpg4usb/)**. As described in my
107+
blog post _[“The Past and Present of GpgFrontend: My Journey with an Open-Source
108+
Encryption Tool”](https://blog.bktus.com/en/archives/u8hywl/)_, the project
109+
began with a simple question:
155110

156-
<img width="256" height="256" src="https://image.cdn.bktus.com/i/2024/02/24/f3f2f26a-96b4-65eb-960f-7ac3397a0a40.webp" alt="Logo"/>
111+
> “What if everyone could have a small, reliable, and secure ‘crypto machine’. A
112+
> tool that makes encryption as tangible and trustworthy as turning a key in a
113+
> lock?”
114+
115+
## Project Maintainer
116+
117+
[@Saturneric](https://github.com/saturneric)
118+
119+
You can refer to [HERE](https://www.gpgfrontend.bktus.com/overview/contact) for
120+
my contact details.
157121

158122
## LICENSES
159123

0 commit comments

Comments
 (0)