Skip to content

Commit

Permalink
Add steps for installing dependencies, and some other improvements in…
Browse files Browse the repository at this point in the history
… readme
  • Loading branch information
blurpy committed May 23, 2021
1 parent 087fcfe commit 802e677
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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:
Expand All @@ -29,7 +61,8 @@ $ cd build
$ cmake ..
$ cmake --build .
$ ctest (optional step)
$ ./src/8bit <program.asm>
$ cd ..
$ ./build/src/8bit programs/<program.asm>
```


Expand Down

0 comments on commit 802e677

Please sign in to comment.