Enhance documentation

This commit is contained in:
ownedbywuigi 2025-06-21 06:32:54 -04:00
parent ac2da6ed49
commit 618dd0d0ab
2 changed files with 18 additions and 2 deletions

View file

@ -27,7 +27,7 @@ Initial focus is on implementing the **CPU**, leveraging its architectural simil
## How to Compile Pound
See the [**compilation guide**](/resources/docs/compguide.md) for detailed instructions.
See the [**compilation guide**](/resources/docs/compguide.md) for detailed instructions on how to compile Pound.
## Codebase

View file

@ -1,4 +1,4 @@
# Compiling Pound
# Compiling Pound (incomplete documentation!!)
# To use and compile Pound, you will need to **dump your own Switch or Switch 2 firmware** and place it in the following directory:
@ -14,4 +14,20 @@
## Linux (Debian/Ubuntu)
### Installing dependencies and cloning Pound
Run the following in your terminal:
``sudo apt update
sudo apt install -y ninja-build clang lld cmake ccache libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxinerama-dev libwayland-dev libxkbcommon-dev wayland-protocols git``
Now run the following:
``git clone https://www.github.com/pound-emu/pound.git``
and then:
``cmake -G Ninja -B (where you put pound source code) -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++``
## Linux (Arch/SteamOS)