mirror of
https://github.com/pound-emu/pound.git
synced 2025-12-12 01:36:57 +00:00
Edit documentation
This commit is contained in:
parent
aacd4902df
commit
84b86ac270
2 changed files with 14 additions and 8 deletions
14
README.md
14
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.
|
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:
|
See [documentation](/docs/compguide.md)
|
||||||
|
|
||||||
```
|
|
||||||
/assets/fw/
|
|
||||||
```
|
|
||||||
|
|
||||||
No firmware or system files are provided with this emulator.
|
|
||||||
|
|
||||||
## Codebase
|
## Codebase
|
||||||
|
|
||||||
Pound may reuse certain components from existing Nintendo Switch 1 emulators, such as **Yuzu**.
|
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.
|
All reused code will be explicitly documented and credited in the appropriate sections of the repository.
|
||||||
|
|
||||||
|
## Contributing and working on Pound
|
||||||
|
|
||||||
|
(coming soon)
|
||||||
|
|
@ -1,5 +1,13 @@
|
||||||
# Compiling Pound
|
# 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 only rn bc lazy)
|
||||||
|
|
||||||
## Linux (Fedora/RHEL/openSUSE)
|
## Linux (Fedora/RHEL/openSUSE)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue