Skip to content

INSTALL.md: Textual reformat; no significant changes otherwise #331

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
+79 −63
Open

INSTALL.md: Textual reformat; no significant changes otherwise #331

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
142 changes: 79 additions & 63 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,97 +1,113 @@
# Installation
Installation
============

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

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

#### Debian / Ubuntu / RetroPie
# Debian / Ubuntu / RetroPie
sudo apt update
sudo apt install git g++ cmake \
libzip-dev libcurl4-openssl-dev zlib1g-dev imagemagick
sudo apt install libsdl3-dev libsdl3-image-dev # Debian 13+

```bash
sudo apt-get update
sudo apt-get install git g++ cmake libzip-dev libsdl3-dev libsdl3-image-dev libcurl4-openssl-dev zlib1g-dev imagemagick
```
# Fedora / RHEL / CentOS
sudo dnf install git gcc-c++ cmake libcurl-devel libzip-devel ImageMagick
sudo dnf SDL3-devel SDL3_image-devel

#### Fedora / RHEL / CentOS
# Arch Linux
sudo pacman -Syu
sudo pacman -S base-devel cmake imagemagick libzip libcurl-gnutls zlib
sudo sdl3 sdl3_image

```bash
sudo dnf install git gcc-c++ cmake SDL3-devel SDL3_image-devel libcurl-devel libzip-devel ImageMagick
```
Clone the repo with:

#### Arch Linux
git clone https://github.com/linappleii/linapple.git
cd linapple

```bash
sudo pacman -Syu
sudo pacman -S base-devel cmake imagemagick libzip sdl3 sdl3_image libcurl-gnutls zlib
```

### Clone
Configure and Compile
---------------------

```bash
git clone https://github.com/linappleii/linapple.git
cd linapple
```
# Create a build directory and configure with CMake (skipping tests
# for a faster build). For further configuration options, see below.
cmake -B build -DBUILD_TESTING=OFF

### Configure and Compile
# Compile using all available CPU cores
cmake --build build -j$(nproc)

```bash
# Create a build directory and configure with CMake (skipping tests for a faster build)
cmake -B build -DBUILD_TESTING=OFF
#### Configuration Options

# Compile using all available CPU cores
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=tui` : Build for the terminal using 24-bit color and Unicode characters (no GUI dependencies required).
- `-DFRONTEND=headless` : Build the emulator without GUI or SDL dependencies (useful for automated testing or server environments).
- `-DBUILD_TESTING=OFF` : Skip building the test suite (saves compilation time and dependency fetching).
- `-DREGISTRY_WRITEABLE=ON` : Enable saving emulator configuration settings back to the config file.
- `-DFRONTEND=sdl3` : (Default) Build the emulator with the SDL3-based
graphical frontend.
- `-DFRONTEND=tui` : Build for the terminal using 24-bit color and Unicode
characters (no GUI dependencies required).
- `-DFRONTEND=headless` : Build the emulator without GUI or SDL
dependencies (useful for automated testing or server environments).
- `-DBUILD_TESTING=OFF` : Skip building the test suite (saves compilation
time and dependency fetching).
- `-DREGISTRY_WRITEABLE=ON` : Enable saving emulator configuration settings
back to the config file.
- `-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).
- `-DBUILD_TESTING=OFF` : Skip building the test suite (saves compilation
time and dependency fetching).
- `-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.
- `-DCMAKE_BUILD_TYPE=Debug` : Build with debugging symbols instead of
release optimizations.

### Run Locally
### Run Locally to Test

After building, you can run the emulator directly from the build output directory:
After building, you can run the emulator directly from the build output
directory:

```bash
cd build
./linapple
```
cd build
./linapple

Or, to boot automatically into the standard Apple floppy disk provided with LinApple:
# Or to use the standard floppy image provided with LinApple:
./linapple --autoboot --d1 ../res/Master.dsk

```bash
./linapple --autoboot --d1 ../res/Master.dsk
```

### Installation
Installation
------------

To install LinApple so it can be run from anywhere, use the `install` target.

```bash
cmake --install build
```
cmake --install build

#### 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/`.

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/`.

You can also explicitly define your installation prefix during configuration:
```bash
cmake -B build -DCMAKE_INSTALL_PREFIX=/usr
sudo cmake --install build
```

cmake -B build -DCMAKE_INSTALL_PREFIX=/usr
sudo cmake --install build

After installation, simply run:
```bash
linapple
```

linapple

### Configuration and Assets

LinApple expects to find its configuration file (`linapple.conf`) in your configuration directory (e.g., `~/.config/linapple/linapple.conf`).
LinApple expects to find its configuration file (`linapple.conf`) in your
configuration directory (e.g., `~/.config/linapple/linapple.conf`).

If the emulator cannot find a required asset (like `Master.dsk` or character fonts) in the current directory, it will automatically search the `share` and `config` directories established during installation.
If the emulator cannot find a required asset (like `Master.dsk` or
character fonts) in the current directory, it will automatically search the
`share` and `config` directories established during installation.
Loading