pound-emu_pound/README.md
2025-06-21 06:32:54 -04:00

52 lines
1.8 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/Logo(1024x1024).webp" 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>
## 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).
Future Supports: **Android**, **macOS ARM**
> [!IMPORTANT]
> Pound is still in early development — don't expect miracles.
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 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
(coming soon)
## License
- Distributed under the [**GNU 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.