From 0fc2ffc1ea36a9248c6a92da85a29f7b04b33796 Mon Sep 17 00:00:00 2001 From: undergroundwires Date: Sun, 28 Apr 2024 16:57:55 +0200 Subject: [PATCH] Add system requirements documentation #134 - Create system requirements documentation for desktop versions, addressing issue #134. - Reorganize related documents into `docs/desktop` for improved structure and accessibility. - Update references to address ARM chip emulation issues noted in user feedback, issue #348. --- README.md | 5 ++- docs/{ => desktop}/desktop-vs-web-features.md | 6 +-- docs/desktop/system-requirements.md | 40 +++++++++++++++++++ 3 files changed, 47 insertions(+), 4 deletions(-) rename docs/{ => desktop}/desktop-vs-web-features.md (95%) create mode 100644 docs/desktop/system-requirements.md diff --git a/README.md b/README.md index c025c4f0..9c80ce06 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,10 @@ - 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy). - 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.2/privacy.sexy-Setup-0.13.2.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.2/privacy.sexy-0.13.2.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.2/privacy.sexy-0.13.2.AppImage). For more options, see [here](#additional-install-options). -For a detailed comparison of features between the desktop and web versions of privacy.sexy, see [Desktop vs. Web Features](./docs/desktop-vs-web-features.md). +See also: + +- [Desktop vs. Web Features](./docs/desktop/desktop-vs-web-features.md): Differences and unique aspects of desktop and web versions. +- [System Requirements](./docs/desktop/system-requirements.md): Hardware and software requirements for the desktop version. 💡 Regularly applying your configuration with privacy.sexy is recommended, especially after each new release and major operating system updates. Each version updates scripts to enhance stability, privacy, and security. diff --git a/docs/desktop-vs-web-features.md b/docs/desktop/desktop-vs-web-features.md similarity index 95% rename from docs/desktop-vs-web-features.md rename to docs/desktop/desktop-vs-web-features.md index fecc0f41..ec4bb15f 100644 --- a/docs/desktop-vs-web-features.md +++ b/docs/desktop/desktop-vs-web-features.md @@ -1,6 +1,6 @@ # Desktop vs. Web Features -This table highlights differences between the desktop and web versions of `privacy.sexy`. +This table outlines the differences between the desktop and web versions of `privacy.sexy`. | Feature | Desktop | Web | | ------- | ------- | --- | @@ -30,11 +30,11 @@ Desktop version inherently allows offline usage. ### Auto-updates -Both the desktop and web versions of privacy.sexy provide timely access to the latest features and security improvements. The updates are automatically deployed from source code, reflecting the latest changes for enhanced security and reliability. For more details, see [CI/CD documentation](./ci-cd.md). +Both the desktop and web versions of privacy.sexy provide timely access to the latest features and security improvements. The updates are automatically deployed from source code, reflecting the latest changes for enhanced security and reliability. For more details, see [CI/CD documentation](./../ci-cd.md). The desktop version ensures secure delivery through cryptographic signatures and version checks. -[Security is a top priority](./../SECURITY.md#update-security-and-integrity) at privacy.sexy. +[Security is a top priority](./../../SECURITY.md#update-security-and-integrity) at privacy.sexy. > **Note for macOS users:** On macOS, the desktop version's auto-update process involves manual steps due to Apple's code signing costs. > Users get notified about updates but might need to complete the installation manually. diff --git a/docs/desktop/system-requirements.md b/docs/desktop/system-requirements.md new file mode 100644 index 00000000..f554b73a --- /dev/null +++ b/docs/desktop/system-requirements.md @@ -0,0 +1,40 @@ +# System Requirements for the Desktop Version + +The following system requirements are the official ones for the desktop version. +While we have tested and confirmed these requirements, the application might also work on other +systems or configurations that haven't undergone official testing. + +## Windows + +- **Version:** Windows 10 and later. +- **Processor:** Intel Pentium 4 or later. +- **Architecture:** 64-bit (x64), ARM. + +> **⚠️ Compatibility Note:** +> ARM version is only compatible with Windows 11 and later. +> It runs non-natively, leading to slower performance due to emulation [1]. + +## macOS + +- **Version:** macOS Catalina (10.15) and later. +- **Architecture:** Intel-based (64-bit), Apple Silicon (ARM). + +> **⚠️ Compatibility Note:** +> Apple Silicon version runs non-natively, leading to slower performance due to emulation [2]. + +## Linux + +- **Version:** Ubuntu 18.04 and later, Fedora 32 and later, and Debian 10 and later. +- **Processor:** Intel Pentium 4 or later. +- **Architecture:** 64-bit (x64). + +## References + +System requirements reflect Electron's platform capabilities [3] and Chromium's recommended configurations [4]. + +For details on the build process, see [electron-builder configuration file](./../../electron-builder.cjs). + +[1]: https://web.archive.org/web/20240428082726/https://learn.microsoft.com/en-us/windows/arm/add-arm-support#emulation-on-arm-based-devices-for-x86-or-x64-windows-apps "Add support Arm devices to your Windows app | Microsoft Learn | learn.microsoft.com" +[2]: https://archive.today/2024.04.28-082901/https://developer.apple.com/documentation/apple-silicon/building-a-universal-macos-binary%23overview "Building a universal macOS binary | Apple Developer Documentation | developer.apple.com" +[3]: https://archive.ph/2024.04.28-082958/https://github.com/electron/electron/blob/main/README.md#platform-support "Platform Support | electron/README.md at main · electron/electron · GitHub | github.com" +[4]: https://web.archive.org/web/20240428082945/https://support.google.com/chrome/a/answer/7100626?hl=en "Chrome browser system requirements - Chrome Enterprise and Education Help | support.google.com"