Add build instructions to README.md

This commit is contained in:
InvisibleUp 2021-08-19 19:52:19 -07:00
parent 1fdcd1dba1
commit cf288d5361

View File

@ -8,6 +8,13 @@ Forked from Mini vMac v36.4 by Paul C. Pratt (http://www.gryphel.com/c/minivmac)
This fork was created to clean up and modernize the code base, make the project easier to compile and hack on, and allow for much easier user configuration. The intent of Mini vMac was to create a "emulator collection" of many very optimized "variations" of the same codebase. I consider this much more trouble than it's worth, and intend to focus more on maintainability and accuracy.
## How to Compile
1. Install the SDL2 libraries (on Ubuntu/Debian, this is `sudo apt install libsdl2-dev`)
2. `git clone --recursive` this repository
3. Run `meson build`
4. Navigate to the `build/` directory and run `meson compile`
5. Add `vMac.ROM` to the build directory and run the program!
## Supported Platforms
µvMac *absolutely requires* SDL2. There are no plans to support platforms that SDL2 does not target. For 99% of users, this should not be a concern. Dropping support for esoteric platforms and exclusively using SDL2 vastly simplifies the complexity of the code.
@ -26,7 +33,7 @@ Here's an incomplete list of platforms that can, in theory, be targeted. These a
![System 7.1 running on an emulated Macintosh Plus](docs/macplus.png)
![System 7.1 running on an emulated Macintosh II](docs/macii.png)
## Legal info
## Legal Info
You can redistribute µvMac and/or modify it under the terms
of version 2 of the GNU General Public License as published by