Update README.md (#19)

added a credits section and some minor changes.
This commit is contained in:
Nicola 2025-06-19 16:10:49 +02:00 committed by GitHub
parent 6104a70822
commit 86e25cf6e7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,37 +2,49 @@
<img src="/assets/Logo(1024x1024).webp" height="150px"> <img src="/assets/Logo(1024x1024).webp" height="150px">
<br><br> <br><br>
<img src="https://img.shields.io/github/stars/pound-emu/pound" width="100"> <img src="https://img.shields.io/github/stars/pound-emu/pound" width="100">
<a href="https://github.com/pound-emu/pound/actions?query=branch%3Amain"><img src="https://img.shields.io/badge/Latest Builds-Here-aa00aa.svg" width="150"></a> <a href="https://github.com/pound-emu/pound/actions?query=branch%3Amain">
<img src="https://img.shields.io/badge/Latest Builds-Here-aa00aa.svg" width="150">
</a>
<br><br> <br><br>
Pound Pound
</h1> </h1>
<p align="center">“i think of getting pounded when i see that [name]” - Satisfied Customer</p> <p align="center"><em>“i think of getting pounded when i see that [name]” Satisfied Customer</em></p>
## Overview ## Overview
Join the [**Pound Discord Server**](https://discord.gg/aMmTmKsVC7)! 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] > [!IMPORTANT]
> Pound is very early in development, don't expect any miracles. > 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 ## Codebase
Pound may reuse certain components from existing Nintendo Switch 1 emulators, such as **Yuzu**. Pound reuses selected components from existing Nintendo Switch 1 emulators, primarily **Yuzu**.
All reused code will be explicitly documented and credited in the appropriate sections of the repository. 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) (coming soon)
## License ## 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.