Skip to content

(sdl3 branch) INSTALL: Add second-level headings for readability #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0cjs wants to merge 1 commit into
base: sdl3
Choose a base branch
from
Open

(sdl3 branch) INSTALL: Add second-level headings for readability #266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Installation
Installation
============

### Prerequisites
Prerequisites
-------------

LinApple uses **CMake** as its build system.

Expand All @@ -24,6 +26,10 @@ sudo pacman -Syu
sudo pacman -S base-devel cmake imagemagick libzip sdl3 sdl3_image libcurl-gnutls zlib
```


Fetching and Building
---------------------

### Clone

```bash
Expand All @@ -42,13 +48,18 @@ cmake --build build -j$(nproc)
```

#### Build Options

You can pass various options to the `cmake` configuration step:
- `-DFRONTEND=sdl3` : (Default) Build the emulator with the SDL3-based graphical frontend.
- `-DFRONTEND=headless` : Build the emulator without GUI or SDL dependencies (useful for automated testing or server environments).
- `-DREGISTRY_WRITEABLE=ON` : Enable saving emulator configuration settings back to the config file.
- `-DPROFILING=ON` : Enable `gprof` profiling output.
- `-DCMAKE_BUILD_TYPE=Debug` : Build with debugging symbols instead of release optimizations.


Execution and Installation
--------------------------

### Run Locally

After building, you can run the emulator directly from the build output directory:
Expand All @@ -72,7 +83,12 @@ To install LinApple so it can be run from anywhere, use the `install` target.
cmake --install build
```


Configuration Notes
-------------------

#### XDG Compliance (Linux)

The build system uses standard `GNUInstallDirs` and automatically adapts to your privileges:
- **Non-root install (Default):** If you run `cmake --install build` as a regular user without overriding the prefix, it will install to `~/.local/bin/`, `~/.local/share/linapple/`, and `~/.config/linapple/`. This is fully compliant with XDG Base Directory specifications and does not require `sudo`.
- **System-wide install (Root):** If you run `sudo cmake --install build`, it will install system-wide to `/usr/local/bin/`, `/usr/local/share/linapple/`, and `/usr/local/etc/linapple/`.
Expand Down
Loading