From 0b2186bb0dbb8ec30b2e1525defab240e1d24e60 Mon Sep 17 00:00:00 2001 From: 57 44 <103148895+ManyLinesOfCode@users.noreply.github.com> Date: Tue, 25 Apr 2023 14:42:00 -0400 Subject: [PATCH 1/2] Improve README.md --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4e9dc03..0a81a8d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,22 @@ # sm -Our discord server is: https://discord.gg/AJJbJAzNNJ +Sm is a PC port of Super Metroid compatible with Windows and Linux systems. -Early version. It has bugs and the code is messy. +Currently, it's in an early version. -For building instructions, see: https://github.com/snesrev/sm/blob/main/BUILDING.md +## Usage -Put sm.smc (sha1 hash da957f0d63d14cb441d215462904c4fa8519c613) in the root folder. When running, it will run both versions and compare frame by frame. If it detects a mismatch, it saves a snapshot in saves/ and displays a counter on screen counting down from 300. +To build: +> Note that the name of the SDL2 package varies between Linux distros. Th below exmaple is for Debian. +```bash +apt install libsdl2-dev +git clone --recursive https://github.com/snesrev/sm +cd sm +make +``` +Once done, place a Super Metroid ROM into the `sm` folder and rename it to "sm.smc". +If building on another Linux distro, macOS or Windows, see [BUILDING.md](BUILDING.md). + +# +Consider joining the Discord server: https://discord.gg/AJJbJAzNNJ From da6abf4929b1f6489f9dc88b7329ce74a2e0268e Mon Sep 17 00:00:00 2001 From: 57 44 <103148895+ManyLinesOfCode@users.noreply.github.com> Date: Tue, 25 Apr 2023 15:01:19 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a81a8d..98506f6 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Currently, it's in an early version. ## Usage To build: -> Note that the name of the SDL2 package varies between Linux distros. Th below exmaple is for Debian. +> Note that the name of the SDL2 package varies between Linux distros. The below exmaple is for Debian. ```bash apt install libsdl2-dev git clone --recursive https://github.com/snesrev/sm