# GpgFrontend
[](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade)
[](https://github.com/saturneric/GpgFrontend/actions/workflows/release.yml)
[](https://github.com/saturneric/GpgFrontend/actions/workflows/testing-nightly.yml)
GpgFrontend is a free, open-source, robust yet user-friendly, compact and
cross-platform tool for [OpenPGP](https://www.openpgp.org/) encryption. It
stands out as an exceptional GUI frontend for the modern
[GnuPG](https://www.gnupg.org/) (gpg).
When using GpgFrontend, you can:
- Rapidly encrypt text, files or emails.
- Digitally sign your text, files or emails with ease.
- Conveniently manage all your GPG keys on your device.
- Transfer all your GPG keys between devices safely and effortlessly.
- Furthermore, you can build and run it on various operating systems, including
Windows, macOS, Linux, FreeBSD, and more.
GpgFrontend is **PERMANENTLY FREE** to use. If you’d like to support it,
consider giving the project a ⭐ on GitHub. Your support not only helps it grow
but also spreads the word, allowing more people to discover and benefit from
GpgFrontend. Every contribution is highly appreciated!
## Table of Contents
- [GpgFrontend](#gpgfrontend)
- [Table of Contents](#table-of-contents)
- [User Manual](#user-manual)
- [Developer Document](#developer-document)
- [Language Support](#language-support)
- [Supported Languages](#supported-languages)
- [Modules](#modules)
- [Contact](#contact)
- [Contributing \& Bugs Report](#contributing--bugs-report)
- [Quick Start with GitHub Codespaces](#quick-start-with-github-codespaces)
- [Project Maintainer](#project-maintainer)
- [Project's Logo](#projects-logo)
- [LICENSES](#licenses)
## User Manual
GpgFrontend provides documentations on its main features. If you want to know
how to install, please read the [User
Manual](https://www.gpgfrontend.bktus.com/overview/glance) instead of README.
The code for the user manual is maintained in [this
repository](https://github.com/saturneric/GpgFrontend-Manual.git).
## Developer Document
You can view the developer documentations that is synchronized with the current
latest develop code. [Developer Document](https://doxygen.gpgfrontend.bktus.com)
will help you understand the source code and get involved more quickly in the
process of contributing to open source.
The code for the developer documentations is maintained in [this
repository](https://github.com/saturneric/GpgFrontend-Doxygen.git).
## Language Support
If you find an error in any of the translations or need to add a new one, we
welcome you to [join our translation
work](https://www.gpgfrontend.bktus.com/appendix/translate-interface).
### Supported Languages
GpgFrontend currently supports an array of languages including:
- English
- Chinese
- French
- German
- Italian
Contributors: [SHOW](TRANSLATORS)
## Modules
GpgFrontend supports extensive module development, allowing users to customize
their experience. Modules can encapsulate functionality, enabling users to
enable or disable features as needed. Users can refer to existing module code
for guidance and are encouraged to contribute to the [Module
Repository](https://github.com/saturneric/GpgFrontend-Modules.git) to reach a
broader audience.
As the development is still in its infancy, there are not enough modules and
many API interfaces have not been stabilized. So the discussion is open for the
development of new modules and the introduction of API interfaces.
## Contact
Please refer to [HERE](https://www.gpgfrontend.bktus.com/overview/contact) for
my contact details.
## Contributing & Bugs Report
Feel free to dive in! [Open an
issue](https://github.com/saturneric/GpgFrontend/issues/new) or submit PRs if
you prefer to use GitHub. For anonymous users, Git patches can be delivered by
[mail](mailto:eric@bktus.com). If you don't have a GitHub account or prefer not
to register, you are welcome to communicate with me via email.
[Contributing Guide](https://www.gpgfrontend.bktus.com/appendix/contribute)
### Quick Start with GitHub Codespaces
[](https://codespaces.new/saturneric/GpgFrontend)
With just one click, you can quickly launch a fully configured development
environment in GitHub Codespaces.
## Project Maintainer
[@Saturneric](https://github.com/saturneric)
I’m always eager to hear your suggestions for improvement. My goal is to
continuously enhance the usability of GpgFrontend and address critical issues
effectively. Your feedback is highly valued and has a great chance of being
implemented in the next release. Feel free to share your ideas and insights via
Issues, email, or any other convenient method. Together, we can make GpgFrontend
even better!
## Project's Logo
## LICENSES
GpgFrontend itself is licensed under the [GPLv3](COPYING).
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_large)