From 84b86ac27063909afa4a5811d2f1f917333b0e18 Mon Sep 17 00:00:00 2001 From: ownedbywuigi Date: Mon, 16 Jun 2025 12:55:54 -0400 Subject: [PATCH] Edit documentation --- README.md | 14 ++++++-------- docs/compguide.md | 8 ++++++++ 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 77e9b70..28d1900 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,15 @@ Also check out [obomori](https://github.com/Nikilites/oboromi), another emulator 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. -## Firmware Requirement +## How to compile Pound -To use Pound, you **will** need to **dump your own Switch or Switch 2 firmware** and place it in the following directory: - -``` -/assets/fw/ -``` - -No firmware or system files are provided with this emulator. +See [documentation](/docs/compguide.md) ## 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. + +## Contributing and working on Pound + +(coming soon) \ No newline at end of file diff --git a/docs/compguide.md b/docs/compguide.md index c612811..4446c6d 100644 --- a/docs/compguide.md +++ b/docs/compguide.md @@ -1,5 +1,13 @@ # Compiling Pound +# To use and compile Pound, you will need to **dump your own Switch or Switch 2 firmware** and place it in the following directory: + +``` +/assets/fw/ +``` + +# No firmware or system files are provided with this emulator. + (linux only rn bc lazy) ## Linux (Fedora/RHEL/openSUSE)