diff options
Diffstat (limited to 'src/content/docs/appendix')
| -rw-r--r-- | src/content/docs/appendix/setup-dev-env.md | 50 | ||||
| -rw-r--r-- | src/content/docs/appendix/system-requirement.md | 68 |
2 files changed, 59 insertions, 59 deletions
diff --git a/src/content/docs/appendix/setup-dev-env.md b/src/content/docs/appendix/setup-dev-env.md index a83dd43..5a89123 100644 --- a/src/content/docs/appendix/setup-dev-env.md +++ b/src/content/docs/appendix/setup-dev-env.md @@ -12,7 +12,7 @@ that the compilation, build, and testing processes are consistent across environments. This approach minimizes integration issues and allows for smoother development workflows. -## Leveraging GitHub Codespaces for Rapid Environment Setup +## Leveraging GitHub Codespaces To simplify and expedite the setup of a consistent development environment, we recommend using GitHub Codespaces. Codespaces offers a cloud-hosted, @@ -21,7 +21,7 @@ your GitHub Actions workflows. This enables you to quickly create an environment that mirrors your CI pipeline, reducing the overhead of manual environment configuration. -### Quick Start with GitHub Codespaces +### Quick Start [](https://codespaces.new/saturneric/GpgFrontend) @@ -29,7 +29,7 @@ Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/sat With just one click, you can quickly launch a fully configured development environment in GitHub Codespaces. -### Manual Setup with GitHub Codespaces +### Manual Setup 1. Navigate to your GitHub repository. 2. Click on the Code button and select Open with Codespaces. @@ -40,7 +40,7 @@ environment in GitHub Codespaces. 4. The Codespace environment will include all necessary dependencies and tools, ensuring consistency with the CI environment. -## Manual Local Environment Setup (If not using Codespaces) +## Local Environment Setup (without Codespaces) ### Prerequisites @@ -49,11 +49,34 @@ environment in GitHub Codespaces. ### Clone the Repository +GitHub: + ```bash git clone https://github.com/saturneric/GpgFrontend.git cd GpgFrontend ``` +[BKTUS](https://bktus.com): + +```bash +git clone https://git.bktus.com/GpgFrontend/GpgFrontend.git +cd GpgFrontend +``` + +> Note: The BKTUS repository serves as the main development repository. Many +> updates and commits are first pushed here for validation and testing before +> being merged into the public GitHub repository. + +After entering the project directory, be sure to initialize and update +submodules (required for dependencies and third-party libraries): + +```bash +git submodule update --init --recursive +``` + +This step is necessary to fetch all required submodules used by the project. If +you skip this, the build may fail due to missing dependencies. + ### Configure Git Line Endings This step ensures that line endings are consistent across different operating @@ -66,29 +89,29 @@ git config --global core.eol lf ### Install Dependencies -- **On Ubuntu 20.04 or later:** +- **On Ubuntu 22.04 or later:** ```bash sudo apt-get update sudo apt-get install -y build-essential cmake ninja-build libarchive-dev libssl-dev libgpgme-dev ``` -- **On macOS 12 or later:** +- **On macOS 13 or later:** ```bash brew install cmake openssl@3 ninja libarchive gpgme brew link --force openssl@3 ``` -- **For Windows (via MSYS2):** Set up MSYS2 according to its documentation and - install the necessary packages: +- **For Windows (via MSYS2):** Set up MSYS2 according to [its + documentation](https://www.msys2.org/) and install the necessary packages: ```bash pacman -Syu pacman -S mingw-w64-x86_64-cmake msys2-runtime-devel mingw-w64-x86_64-ninja mingw-w64-x86_64-gnupg mingw-w64-x86_64-libarchive mingw-w64-x86_64-gpgme ``` -### Install Qt6 (if applicable) +### Install Qt6 Use the Qt online installer or your package manager to install Qt6 and the required modules for your project. @@ -101,6 +124,15 @@ $ cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug .. $ ninja ``` +:::caution[Note for v2.1.9] + +Starting from version 2.1.9, GpgFrontend requires gpgme 2.0 or newer. However, +most package managers do not provide a sufficiently recent version of gpgme at +this time. It is strongly recommended to enable in-tree building of gpgme by +setting the CMake option: `GPGFRONTEND_LINK_GPGME_INTO_CORE=ON` + +::: + ### Notes - Adjust the build type (`Release`, `Debug`, etc.) as needed. diff --git a/src/content/docs/appendix/system-requirement.md b/src/content/docs/appendix/system-requirement.md index f3a6899..9cf45db 100644 --- a/src/content/docs/appendix/system-requirement.md +++ b/src/content/docs/appendix/system-requirement.md @@ -2,67 +2,35 @@ title: System Requirement --- -Before proceeding with the installation and usage of GpgFrontend, it's crucial -to understand the system requirements that ensure optimal performance. This -section provides comprehensive details about the necessary software -dependencies, hardware specifications, and the compatible operating systems. -Meeting these requirements will ensure a smooth, efficient experience while -using GpgFrontend. - -Please read the following subsections carefully to confirm that your system -aligns with the recommended configurations. +Before installing GpgFrontend, please verify that your system meets the +following specifications to ensure optimal performance and feature support. ## Hardware -While the specific hardware requirements largely depend on the size and -complexity of the data you're working with, we generally recommend: - -A computer with at least 1 GB of RAM. However, 2 GB or more is preferable for -smoother performance. The majority of these resources are allocated to your -operating system, but around 100 MB of memory is needed to ensure the smooth -running of GpgFrontend. At least 200 MB of free disk space for software -installation. Additional space will be needed for ongoing work. - -Please note, these requirements are intended to be guidelines rather than strict -rules. It's possible that GpgFrontend will work on lower-spec hardware, but for -optimal performance, the above specifications are recommended. +For smooth operation, we recommend: -## Operating System +- RAM: 2 GB or more (minimum 1 GB) +- Disk: 200 MB free for installation (plus extra for files) +- CPU: Dual-core or better -GpgFrontend is compatible with major operating systems including Linux, macOS, -and Windows. Specifically, it recommends Windows 7 and later, macOS 11 and -later, and Ubuntu 20.04 LTS or other equivalent Linux distributions. +These are guidelines. GpgFrontend may run on lower-spec machines, but +performance can suffer with large files or keyrings. -## Software +## OS -To ensure GpgFrontend functions seamlessly, it relies on the following software -dependencies: +- Windows 10 / 11 +- macOS 13 or later +- Ubuntu 22.04 or later -- **Qt Framework:** GpgFrontend is developed using the Qt framework to offer a - rich user experience and cross-platform compatibility. The application - includes: +> Note: Only 64-bit systems are supported. 32-bit systems are not supported. - - **Qt6:** The primary build utilizes Qt6, ensuring a modern interface and - robust performance. Qt6 is included in the release packages for Linux, - macOS, and Windows, offering straightforward setup without additional - installations. - - **Qt5 Support for Windows:** Recognizing the need to accommodate users on - older versions of Windows, GpgFrontend also provides a Qt5-based version. - This variant ensures compatibility with earlier Windows environments, - extending the tool's accessibility and usability. +## GnuPG -- **GnuPG 2.2.0 or Higher:** GpgFrontend integrates with GnuPG for its - cryptographic operations, including encryption, decryption, and digital - signing. While GpgFrontend supports GnuPG version 2.2.0 or newer, some - features may not be fully functional with versions below 2.4.0. For the best - compatibility and to ensure access to all features, it is strongly recommended - to use GnuPG 2.4.0 or higher. Please note that GnuPG 1.x versions are not - supported due to significant differences in functionality and lack of modern - security updates. +- Minimum 2.2.0 +- Recommended 2.4.0+ for full feature support -By catering to a wide range of operating systems and ensuring backward -compatibility with older Windows versions through Qt5 support, GpgFrontend -strives to be as inclusive and accessible as possible. +> On Windows: GnuPG is bundled with the Application, so no separate installation +> needed. ## Network |