From 0290219acecede648064836a7b113460bf6ca911 Mon Sep 17 00:00:00 2001 From: InvisibleUp Date: Fri, 24 Nov 2023 21:40:50 -0800 Subject: [PATCH] Update README, set default build tool to Ninja --- CMakePresets.json | 3 ++- README.md | 11 +++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CMakePresets.json b/CMakePresets.json index 932e1bc..5dd277e 100644 --- a/CMakePresets.json +++ b/CMakePresets.json @@ -3,10 +3,11 @@ "configurePresets": [ { "name": "debug", + "generator": "Ninja", "toolchainFile": "${sourceDir}/vcpkg/scripts/buildsystems/vcpkg.cmake", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" - } + } } ] } \ No newline at end of file diff --git a/README.md b/README.md index 7f8b459..52ee603 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,17 @@ This fork was created to clean up and modernize the code base, make the project So far µvMac has only been tested on Windows and Linux. No other operating systems are supported at this time. +# Building + +µvMac uses CMake 3.21+ and [vcpkg](https://vcpkg.io/). + +1. `git submodule update --init --recursive` +2. Install CMake and a suitable C compiler. Windows users can use Visual Studio. Ubuntu users may need to use the [Kitware APT repo](https://apt.kitware.com/). +3. Run `cmake -B [build directory] -S . --preset=debug` (or open the project your IDE). Note that on Linux the configuration may fail due to missing system packages. Install those as needed. +4. Enter your build directory and run `ninja` to build +5. Acquire a Macintosh Plus ROM and a system disk and place it in the build directory, named `vMac.ROM` +6. Start the application and drag the system disk to the window. + ## Legal info You can redistribute µvMac and/or modify it under the terms