From 58ba1e4cb4d239380aeb7434a8a37e2d512c211b Mon Sep 17 00:00:00 2001 From: nmzik Date: Sun, 11 Oct 2026 01:13:14 +0200 Subject: [PATCH] docs: update README wording and grammar --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 9f53cb3e..e7bf10b0 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ [![Status](https://img.shields.io/badge/status-active%20development-orange.svg)](#current-status) [![License](https://img.shields.io/badge/license-GPL--2.0-blue.svg)](LICENSE) -**[Weekly updates](https://github.com/KytyPS5/KytyPS5/discussions/862)** — game progress, recent fixes and ongoing development. +**[Weekly updates](https://github.com/KytyPS5/KytyPS5/discussions/862)** — game progress, recent fixes, and ongoing development. **[Development on Discord](https://discord.gg/UNrkMqGaBg)** — KytyPS5 development. -KytyPS5 is a free and open-source PlayStation 5 emulator written in C++ for Windows and Linux, -with experimental macOS support. It is based on a heavily modified version of +KytyPS5 is a free and open-source PlayStation 5 translation layer written in C++ for Windows +and Linux, with experimental macOS support. It is based on a heavily modified version of [Kyty](https://github.com/InoriRus/Kyty). The project is in active development, and behavior can change significantly between builds. @@ -23,13 +23,13 @@ can change significantly between builds. ## Current Status -KytyPS5 can boot 2D games and a selection of 3D games, including titles built with Unreal Engine +KytyPS5 can boot 2D and 3D games, including titles built with Unreal Engine 4/5, Unity, and custom engines. External low-level emulation modules are neither required nor planned. Development is currently focused on expanding game compatibility and improving boot reliability. -Windows and Linux are the primary platforms and receive the most testing. +Windows and Linux are the primary target platforms and receive the most testing. macOS support is experimental. The emulator is built for x86-64 and runs on Apple Silicon under Rosetta 2, with Vulkan provided by MoltenVK. A small number of titles have been verified in-game @@ -91,14 +91,14 @@ issues first, then use the **Game Emulation Status Report** template and attach Keep each PR focused. Name the affected game, describe the exact problem, and provide evidence showing what the change fixes. -Code contributions should be focused, build successfully on the platforms they touch, and include -relevant tests where practical. Windows is the primary target, so a change that alters shared code -should not regress it; changes confined to a platform's own code paths only need to build there. Because KytyPS5 is still evolving quickly, consider opening an issue before -starting a large change. +Windows and Linux are the primary target platforms, so changes to shared code should not +introduce regressions on either platform. Changes confined to a platform's own code paths +only need to build on that platform. Because KytyPS5 is still evolving quickly, consider +opening an issue before starting a large change. ### Formatting -Set up the clang-format hook after cloning: +Set up the clang-format hook after cloning. Install `pre-commit` using the method appropriate for your platform: @@ -177,9 +177,9 @@ The finished application and its runtime dependencies will be placed in ### Building on Linux -Install the toolchain and the libraries the bundled SDL3 needs. Without the audio, Wayland and -udev development packages SDL3 quietly configures itself without those backends, and the resulting -build has no working sound and no gamepad hotplug: +Install the toolchain and the libraries the bundled SDL3 needs. Without the audio, Wayland, and +udev development packages, SDL3 quietly configures itself without those backends, and the resulting +build has no working audio or gamepad hotplug support: ```bash sudo apt-get install --no-install-recommends \ @@ -189,8 +189,8 @@ sudo apt-get install --no-install-recommends \ libasound2-dev libpulse-dev libudev-dev libdbus-1-dev libwayland-dev wayland-protocols ``` -Qt 6 (Concurrent, Network, Widgets) is required for the launcher — either the distribution packages -(`qt6-base-dev`) or an official Qt installation. +Qt 6 (Concurrent, Network, and Widgets) is required for the launcher. Use your distribution's +packages (`qt6-base-dev`) or an official Qt installation. ```bash git submodule update --init --recursive @@ -204,7 +204,7 @@ cmake --install _Build/linux --prefix _Build/linux/install ``` The install step copies the Qt libraries and plugins next to the binaries, so -`_Build/linux/install` runs without a matching system Qt. FFmpeg is linked statically +`_Build/linux/install` runs without a matching system Qt installation. FFmpeg is linked statically from the pinned [KytyPS5 FFmpeg core](https://github.com/KytyPS5/ext-ffmpeg-core) release, including VP9 and WebM support. System FFmpeg packages are not required. @@ -259,7 +259,7 @@ Requirements: - An Apple Silicon Mac with Rosetta 2 installed (`softwareupdate --install-rosetta`) - Xcode (or the Command Line Tools) - Homebrew packages: `brew install cmake ninja glslang python` -- Qt 6 (Concurrent, Network, Widgets) with x86-64 support. The official Qt installation is +- Qt 6 (Concurrent, Network, and Widgets) with x86-64 support. The official Qt installation is universal and works; Homebrew's Qt is arm64-only and will not link ```bash @@ -275,14 +275,14 @@ cmake --install _Build/macos --prefix _Build/macos/install ``` The build re-signs `kyty_emulator` with the JIT entitlements it needs to execute translated -guest code; no manual signing step is required. When the launcher is built, the install +guest code; no manual signing step is required. When the launcher is built, the installation also produces `_Build/macos/install/KytyPS5.app` — double-click to launch the GUI. A flat `kyty_emulator` is kept for CLI usage. Vulkan comes from MoltenVK. Download `MoltenVK-macos.tar` from the [MoltenVK releases](https://github.com/KhronosGroup/MoltenVK/releases), then copy `MoltenVK/dynamic/dylib/macOS/libMoltenVK.dylib` next to the flat `kyty_emulator` -(and, for the bundle, into `KytyPS5.app/Contents/Frameworks/`) and ad-hoc sign it: +(and, for the bundle, into `KytyPS5.app/Contents/Frameworks/`) and sign it with an ad hoc signature: ```bash codesign --force --sign - _Build/macos/install/libMoltenVK.dylib @@ -350,7 +350,7 @@ for your platform from GitHub, checks its SHA-256 checksum, and restarts after i any running games first. Settings, saves, patches, and other files outside the release package are preserved; replacement failures restore the previous files. The installation folder must be writable. If a package cannot be installed automatically, the updater offers the GitHub release page. -Source and fork builds do not replace themselves with official releases. +Source builds and builds from forks do not replace themselves with official releases. The emulator can also be started directly with a legally obtained game directory, ELF file, or ZArchive dump: @@ -407,5 +407,5 @@ licenses included with those components. - [InoriRus/Kyty](https://github.com/InoriRus/Kyty) — KytyPS5 is based on a heavily modified version of the original Kyty project. - [shadps4-emu/shadPS4](https://github.com/shadps4-emu/shadPS4) — reference for understanding PS4 - memory behavior, GPU resource aliasing and cache coherency, + memory behavior, GPU resource aliasing, cache coherency, and the AVPlayer implementation.