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.

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

Adding compiling instructions #203

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
53 changes: 37 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
bsnes
=====
# bsnes

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://github.com/bsnes-emu/bsnes/blob/master/LICENSE.txt)

![bsnes logo](bsnes/target-bsnes/resource/logo.png)

bsnes is a multi-platform Super Nintendo (Super Famicom) emulator, originally
developed by [Near](https://near.sh), which focuses on performance,
features, and ease of use.

Unique Features
---------------
## Community

- [Official git repository](https://github.com/bsnes-emu/bsnes)
- [Discussion Forum](https://helmet.kafuka.org/bboard/forum.php?id=6)
- [![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?logo=discord)](https://discord.gg/B27hf27ZVf)

## Unique Features

- True Super Game Boy emulation (using the SameBoy core by Lior Halphon)
- HD mode 7 graphics with optional supersampling (by DerKoun)
Expand All @@ -24,8 +30,7 @@ Unique Features
- Optional higan game folder support (standard game ROM files are also fully supported!)
- Advanced mapping system allowing multiple bindings to every emulated input

Standard Features
-----------------
## Standard Features

- MSU1 support
- BPS and IPS soft-patching support
Expand Down Expand Up @@ -53,23 +58,39 @@ Standard Features
- Multi-monitor support
- Turbo support for controller inputs

Links
-----

- [Official git repository](https://github.com/bsnes-emu/bsnes)
- [Official Discord](https://discord.gg/B27hf27ZVf)

Nightly Builds
--------------
## Nightly Builds

- [Download](https://cirrus-ci.com/github/bsnes-emu/bsnes/master)
- ![Build status](https://api.cirrus-ci.com/github/bsnes-emu/bsnes.svg?task=windows-x86_64-binaries)
- ![Build status](https://api.cirrus-ci.com/github/bsnes-emu/bsnes.svg?task=macOS-x86_64-binaries)
- ![Build status](https://api.cirrus-ci.com/github/bsnes-emu/bsnes.svg?task=linux-x86_64-binaries)
- ![Build status](https://api.cirrus-ci.com/github/bsnes-emu/bsnes.svg?task=freebsd-x86_64-binaries)

Preview
-------
## Compiling instructions

If you want to compile by yourself, it's also very easy to. Just follow these steps:

### Prerequisites

* Updated C/C++ compilation suite already installed and with enviroment paths ready for your operational system
For Windows, we can suggest [MinGW] (http://mingw-w64.org/).
Another good suggestion [MSYS2](https://www.msys2.org/). It also has versions for MacOS and Linux (and even come in some distributions).
* (optional) [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).

### Generating the executable

1. Open a command prompt in your directory of choice and clone the most recent version of the code in a directory of your choice.
* you can get it ready manually just extracting the source code (that you can download just clicking in the "Code" button and choosing "download zip") in your directory of choice
* if you have Git installed, you can do it with the command prompt/terminal:
`git clone https://github.com/bsnes-emu/bsnes.git`

2. Go to `bsnes` folder with: `cd bsnes`.

3. Now you just need to put the command: `make` (for most of C/C++ compilation suites) or `mingw32-make`(if you're using Windows MinGW). The compilation will start.

4. The brand new compiled file will be at directory `./bsnes/out`. Enjoy!

## Preview

![bsnes user interface](.assets/user-interface.png)
![bsnes running Bahamut Lagoon](.assets/bahamut-lagoon.png)
Expand Down