How to Compile RDE Disk Tool

This document provides step-by-step instructions for building the RDE Disk Tool on various platforms.

Prerequisites

Required Tools

Tool	Minimum Version	Description
CMake	3.16+	Build system generator
C++ Compiler	C++17 support	GCC 8+, Clang 7+, or MSVC 2019+
Make/Ninja	Any	Build tool (platform dependent)

Platform-Specific Requirements

Linux (Ubuntu/Debian)

sudo apt update
sudo apt install build-essential cmake git

Linux (Fedora/RHEL)

sudo dnf install gcc-c++ cmake git make

Linux (Arch)

sudo pacman -S base-devel cmake git

macOS

# Install Xcode Command Line Tools
xcode-select --install

# Install CMake via Homebrew
brew install cmake

Windows

Install Visual Studio 2019 or later with "Desktop development with C++" workload
Install CMake from https://cmake.org/download/
Or use MSYS2/MinGW:

pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake make

Building

Quick Start (Linux/macOS)

# Clone the repository (if not already done)
cd /path/to/RetroDeveloperEnvironmentDisktool

# Create build directory
mkdir -p build
cd build

# Configure
cmake ..

# Build
cmake --build .

# The executable will be at: ./rdedisktool

Detailed Build Instructions

Step 1: Create Build Directory

mkdir build
cd build

Step 2: Configure with CMake

Basic configuration:

cmake ..

Release build (optimized):

cmake -DCMAKE_BUILD_TYPE=Release ..

Debug build (with debug symbols):

cmake -DCMAKE_BUILD_TYPE=Debug ..

Specify compiler (optional):

cmake -DCMAKE_CXX_COMPILER=clang++ ..

Specify install prefix:

cmake -DCMAKE_INSTALL_PREFIX=/usr/local ..

Step 3: Build

Using make:

make -j$(nproc)

Using CMake (cross-platform):

cmake --build . --parallel

Verbose build (shows commands):

cmake --build . --verbose

Step 4: Verify Build

./rdedisktool --version

Expected output:

Retro Developer Environment Disk Tool v1.0.0
Supported platforms: Apple II, MSX, X68000

Building on Windows

Using Visual Studio

# Create build directory
mkdir build
cd build

# Configure for Visual Studio 2022
cmake -G "Visual Studio 17 2022" -A x64 ..

# Build Release
cmake --build . --config Release

# Executable location: Release\rdedisktool.exe

Using MinGW (MSYS2)

# In MSYS2 MinGW64 shell
mkdir build
cd build
cmake -G "MinGW Makefiles" ..
mingw32-make -j$(nproc)

Using Ninja (Faster builds)

cmake -G Ninja ..
ninja

Cross-Compilation

Linux to Windows (MinGW)

# Install cross-compiler
sudo apt install mingw-w64

# Configure
cmake -DCMAKE_TOOLCHAIN_FILE=cmake/mingw-w64-x86_64.cmake ..

# Build
make

Build Options

CMake Option	Default	Description
`CMAKE_BUILD_TYPE`	Debug	Build type: Debug, Release, RelWithDebInfo
`CMAKE_INSTALL_PREFIX`	/usr/local	Installation directory
`BUILD_TESTS`	ON	Build test suite

Example:

cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=OFF ..

Post-Build Verification

After building, run core regressions:

cd /path/to/RetroDeveloperEnvironmentDisktool

# Bootdisk protection regression
tests/test_bootdisk_guard_all.sh

# System-file delete prompt regression
tests/test_system_file_delete_prompt.sh

Bootdisk add-and-boot smoke scripts (project root):

./run_applewin_dos33_diskaddtest.sh
./run_applewin_prodos_diskaddtest.sh
./run_openmsx_msxdos2_diskaddtest.sh
./run_px68k_humanos_diskaddtest.sh

These scripts copy boot disks, add files via rdedisktool, and boot each emulator with a single drive to verify boot safety.

Installation

System-wide Installation

sudo cmake --install .

Custom Location

cmake --install . --prefix ~/local

Manual Installation

# Copy binary
sudo cp rdedisktool /usr/local/bin/

# Verify
rdedisktool --version

Troubleshooting

Common Issues

1. CMake version too old

Error: CMake 3.16 or higher is required

Solution:

# Ubuntu/Debian - Install from Kitware repository
sudo apt install apt-transport-https ca-certificates gnupg
curl -s https://apt.kitware.com/keys/kitware-archive-latest.asc | sudo apt-key add -
sudo apt-add-repository 'deb https://apt.kitware.com/ubuntu/ focal main'
sudo apt update
sudo apt install cmake

2. C++17 not supported

Error: error: 'filesystem' is not a namespace-name

Solution: Upgrade compiler or specify C++17 explicitly:

cmake -DCMAKE_CXX_STANDARD=17 ..

3. Missing standard library headers

Error: fatal error: filesystem: No such file or directory

Solution (GCC < 9):

# Link with stdc++fs
cmake -DCMAKE_CXX_FLAGS="-lstdc++fs" ..

4. Permission denied during install

Error: CMake Error: cannot copy file