From 86e25cf6e74ea7b2cea8ab9d264c76d63df4d734 Mon Sep 17 00:00:00 2001 From: Nicola <109990495+Nikilites@users.noreply.github.com> Date: Thu, 19 Jun 2025 16:10:49 +0200 Subject: [PATCH] Update README.md (#19) added a credits section and some minor changes. --- README.md | 46 +++++++++++++++++++++++++++++----------------- 1 file changed, 29 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 48a1b92..ef89fc1 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,50 @@

- -

- - -

-Pound + +

+ + + + +

+ Pound

-

“i think of getting pounded when i see that [name]” - Satisfied Customer

+

“i think of getting pounded when i see that [name]” – Satisfied Customer

## Overview Join the [**Pound Discord Server**](https://discord.gg/aMmTmKsVC7)! -**Pound** is an early **Nintendo Switch 2** emulator for Android, macOS (Intel and ARM), Windows and Linux (Intel and ARM). +**Pound** is an early-stage emulator for the **Nintendo Switch 2**, targeting **Android**, **macOS** (Intel and ARM), **Windows**, and **Linux** (Intel and ARM). -> [!IMPORTANT] -> Pound is very early in development, don't expect any miracles. +> [!IMPORTANT] +> Pound is still in early development — don't expect miracles. -Development will begin with the **CPU**, as its architecture is nearly identical to the original Switch. After that, work will focus on bridging the differences between the two hardware generations. +Initial focus is on implementing the **CPU**, leveraging its architectural similarities to the original Nintendo Switch. Later stages will address differences in hardware between the two console generations. -## How to compile Pound -See [documentation](/docs/compguide.md) +## How to Compile Pound + +See the [**compilation guide**](/docs/compguide.md) for detailed instructions. + ## Codebase -Pound may reuse certain components from existing Nintendo Switch 1 emulators, such as **Yuzu**. -All reused code will be explicitly documented and credited in the appropriate sections of the repository. +Pound reuses selected components from existing Nintendo Switch 1 emulators, primarily **Yuzu**. +All third-party code is clearly documented and properly attributed in the relevant parts of the repository. -## Contributing and working on Pound + +## Contributing (coming soon) + ## License -- [**GPL-3.0 license**](https://github.com/pound-emu/pound/blob/main/LICENSE) +- Distributed under the [**GPL-3.0 license**](https://github.com/pound-emu/pound/blob/main/LICENSE) + + +## Credits + +- Parts of the emulator are based on code from the Yuzu project. +- The phrase *"don't expect miracles"* is borrowed from the [**oboromi**](https://github.com/Nikilites/oboromi) project by **Nikilite** — a Nintendo Switch 2 emulator written in Rust.