From 802e677928e4cfa3bdaf273fb42cf37a82de85c2 Mon Sep 17 00:00:00 2001 From: Christian Ihle Date: Sun, 23 May 2021 13:56:36 +0200 Subject: [PATCH] Add steps for installing dependencies, and some other improvements in readme --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 74b5313..fd5a8d9 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ Please see the link above for documentation on how the computer works. Since the ![Animation of emulator](resources/emulator-animation-subtract.gif) +The column on the right displays the entire contents of the RAM, as well as where the MAR is pointing. + ## Requirements @@ -19,6 +21,36 @@ The emulator builds on Linux, macOS and Windows. It is primarily tested on Linux * sdl2_ttf +### Linux + +Ubuntu: + +``` +sudo apt-get install build-essential cmake libsdl2-dev libsdl2-ttf-dev +``` + +openSUSE: + +``` +sudo zypper install cmake-full libSDL2-devel libSDL2_ttf-devel +``` + + +### macOS + +Install xcode command line tools: + +``` +sudo xcode-select --install +``` + +Install the rest of the tools with [Homebrew](https://brew.sh/): + +``` +brew install cmake sdl2 sdl2_ttf +``` + + ## Build and run Clone the repo first with git or download a zip of the repo. Run the following inside the folder with the code: @@ -29,7 +61,8 @@ $ cd build $ cmake .. $ cmake --build . $ ctest (optional step) -$ ./src/8bit +$ cd .. +$ ./build/src/8bit programs/ ```