pound-emu_pound/README.md
2025-08-08 00:18:47 +01:00

57 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<h1 align="center">
<img src="/resources/pound.png" height="150px">
<br><br>
<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>
<br><br>
Pound
</h1>
<p align="center"><em>“i think of getting pounded when i see that [name]” Satisfied Customer</em></p>
> [!NOTE]
> This project is still being worked on, and we **really** need help as we only have a few developers.
> If you know C++ and think you can help out, hop into the Discord and let us know. :)
## Overview
Join the [**Pound Discord Server**](https://discord.gg/aMmTmKsVC7)!
**Pound** is an early-stage emulator for the **Nintendo Switch 2**, targeting **Windows**, **Linux** and **macOS** (
Intel and Apple Silicon).
Initial focus is on implementing the architectural similarities to the original Nintendo Switch. Later stages of
development will address differences in hardware between the two console generations.
## Disclaimer
The goal of this project is to experiment, research, and educate on the topic
of emulation of modern devices and operating systems. **It is not for enabling
illegal activity**. All information is obtained via reverse engineering of
legally purchased devices and games and information made public on the internet
(you'd be surprised what's indexed on Google...). We are not any way affiliated
with Nintendo or NVidia.
## How to Compile Pound
See the [**compilation guide**](/resources/docs/compguide.md) for detailed instructions on how to compile Pound.
## Codebase
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
See [**here**](/CONTRIBUTING.md) before submitting a pull request.
## License
- Distributed under the [**GNU GPL-2.0 license**](https://github.com/pound-emu/pound/blob/main/LICENSE)
## Credits
- Parts of the emulator are based on code from the Yuzu project.