# Super Metroid

This project is a disassembly of Super Metroid for the Super Famicom (SNES).

This project produces the following ROMs:

* `supermetroid-ntsc.sfc`, the NTSC (Japan/USA) version of Super Metroid. SHA-1
  digest: `da957f0d63d14cb441d215462904c4fa8519c613`

Want to help? [Contribute changes to supermetroid](CONTRIBUTING.md).

## Building

[![Build Status](https://travis-ci.org/strager/supermetroid.svg?branch=master)](https://travis-ci.org/strager/supermetroid)

### Linux

Prerequisites:

* [CMake][cmake-download] version 2.8.9 or newer (included in [Nix](#nix))
* GNU Make (included in [Nix](#nix))
* GCC or Clang (included in [Nix](#nix))

Instructions:

1. Run `make` from a terminal (such as GNOME Terminal or Konsole).

### macOS

Prerequisites:

* [CMake][cmake-download] version 2.8.9 or newer (included in [Nix](#nix))
* GNU Make (included in [Nix](#nix) and Xcode)
* GCC or Clang (included in [Nix](#nix) and Xcode)

Instructions:

1. Run `make` from Terminal.app.

### Windows

Prerequisites:

* [CMake][cmake-download] version 2.8.9 or newer
* nmake (included in [Visual Studio][visual-studio-download])
* MSVC (included in [Visual Studio][visual-studio-download])
* msbuild (included in [Visual Studio][visual-studio-download])

Instructions:

1. Open x64 Native Tools Command Prompt for VS.
2. Navigate to this project's directory.
3. Run `nmake`.

### Nix

You can build on Linux and macOS using [Nix][nix-download].

Instructions:

1. Run `nix-shell`.
2. In the shell, run `make`.

[cmake-download]: https://cmake.org/download/
[nix-download]: https://nixos.org/nix/download.html
[visual-studio-download]: https://visualstudio.microsoft.com/downloads/