Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md #34

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve README.md #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b2186b
Improve README.md
ManyLinesOfCode Apr 25, 2023
da6abf4
Update README.md
ManyLinesOfCode Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. The 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