From 2adc654acc7ab135aa95770f5b7274bd4a1b151e Mon Sep 17 00:00:00 2001 From: Shideravan Date: Wed, 4 Aug 2021 22:43:04 -0300 Subject: [PATCH 1/7] Adding windows compile instructions This may help newcomers on how to easily compile bsnes --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 64dbf8379..7fb6ebf38 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,25 @@ Nightly Builds - ![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) +Compiling instructions (for Windows x64): +-------------- +1. You'll need both MinGW and .git installed in your system. If you already have, you can skip these steps: + I. Download MingGW x64 (http://mingw-w64.org/doku.php). Install and make sure that the following paths are in your enviroment table (you can check searching for "enviroment path" in your windows search and opening "Edit enviroment path"). + ![image](https://user-images.githubusercontent.com/12163923/128277297-4e16f476-e9e1-4fb7-a083-21ec81c2b0be.png) + ![image](https://user-images.githubusercontent.com/12163923/128277634-024c5773-8aaf-4d31-b535-d86df2426502.png) + + + II. Download and install git (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). + +2. Open a command prompt in your directory of choice and clone bsnes/higan/ares with the command: +git clone https://github.com/bsnes-emu/bsnes.git + +3. Go to ´bsnes´ folder with: ´cd bsnes´. + +4. Now you just need to put the command: ´mingw32-make´. The compilation will start. + +5. The brand new compiled file will be at directory ´out´ in this same directory. Enjoy! + Preview ------- From 7d0d7525aa6a795364dee19182535789be76a5c5 Mon Sep 17 00:00:00 2001 From: Shideravan Date: Wed, 4 Aug 2021 22:47:14 -0300 Subject: [PATCH 2/7] Just removing some unnecessary line skips --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 7fb6ebf38..0f7c9c3db 100644 --- a/README.md +++ b/README.md @@ -74,8 +74,6 @@ Compiling instructions (for Windows x64): I. Download MingGW x64 (http://mingw-w64.org/doku.php). Install and make sure that the following paths are in your enviroment table (you can check searching for "enviroment path" in your windows search and opening "Edit enviroment path"). ![image](https://user-images.githubusercontent.com/12163923/128277297-4e16f476-e9e1-4fb7-a083-21ec81c2b0be.png) ![image](https://user-images.githubusercontent.com/12163923/128277634-024c5773-8aaf-4d31-b535-d86df2426502.png) - - II. Download and install git (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). 2. Open a command prompt in your directory of choice and clone bsnes/higan/ares with the command: From c56773bda88248bc6c0a61840183622c608faf4f Mon Sep 17 00:00:00 2001 From: Shideravan Date: Thu, 5 Aug 2021 01:52:09 -0300 Subject: [PATCH 3/7] Better formatting --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0f7c9c3db..27bd18f75 100644 --- a/README.md +++ b/README.md @@ -70,20 +70,25 @@ Nightly Builds Compiling instructions (for Windows x64): -------------- + +If you want to compile by yourself, it's also very easy to. Just follow these steps: + 1. You'll need both MinGW and .git installed in your system. If you already have, you can skip these steps: + I. Download MingGW x64 (http://mingw-w64.org/doku.php). Install and make sure that the following paths are in your enviroment table (you can check searching for "enviroment path" in your windows search and opening "Edit enviroment path"). - ![image](https://user-images.githubusercontent.com/12163923/128277297-4e16f476-e9e1-4fb7-a083-21ec81c2b0be.png) - ![image](https://user-images.githubusercontent.com/12163923/128277634-024c5773-8aaf-4d31-b535-d86df2426502.png) + ![image](https://user-images.githubusercontent.com/12163923/128291920-11b92486-c765-4064-abc1-630164b9f1d8.png) + ![image](https://user-images.githubusercontent.com/12163923/128292012-590136b4-5e90-4518-ac58-1b07b6839533.png) + II. Download and install git (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). 2. Open a command prompt in your directory of choice and clone bsnes/higan/ares with the command: -git clone https://github.com/bsnes-emu/bsnes.git +`git clone https://github.com/bsnes-emu/bsnes.git` -3. Go to ´bsnes´ folder with: ´cd bsnes´. +3. Go to `bsnes` folder with: `cd bsnes`. -4. Now you just need to put the command: ´mingw32-make´. The compilation will start. +4. Now you just need to put the command: `mingw32-make`. The compilation will start. -5. The brand new compiled file will be at directory ´out´ in this same directory. Enjoy! +5. The brand new compiled file will be at directory `./bsnes/out`. Enjoy! Preview ------- From ffbe7a867f9859ba7dc137db398aeaa1657880c5 Mon Sep 17 00:00:00 2001 From: Shideravan Date: Thu, 5 Aug 2021 02:27:43 -0300 Subject: [PATCH 4/7] Small update --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 27bd18f75..fbb7096c7 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,16 @@ bsnes ![bsnes logo](bsnes/target-bsnes/resource/logo.png) -bsnes is a multi-platform Super Nintendo (Super Famicom) emulator, originally +**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. +features and ease of use. + +Community +--------- + + - [Official git repository](https://github.com/bsnes-emu/bsnes) + - [Discussion Forum](https://helmet.kafuka.org/bboard/forum.php?id=6) + - [Discord Chat](https://discord.gg/xdsQRXfuCh) Unique Features --------------- @@ -68,8 +75,8 @@ Nightly Builds - ![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) -Compiling instructions (for Windows x64): --------------- +Compiling instructions (for Windows x64) +---------------------------------------- If you want to compile by yourself, it's also very easy to. Just follow these steps: From c74f5d77e0c7eec4a4117840162d2066dd31bf7e Mon Sep 17 00:00:00 2001 From: Shideravan Date: Sat, 21 Aug 2021 23:33:06 -0300 Subject: [PATCH 5/7] More changes, following the suggestions * MSYS is being recomended as another good alternative (thanks for the suggestion @jchv * bsnes isn't bold anymore * I changed back the link in comunity section for the same invite link already it has (and now with a fancy new button) * Changed the I and II to more usual markdown items * Now all the text in the README is using default MD (then rather than "-----" we have hyrarchical subtitling * The prerequisites now is separated and better explained. Note that I'm just pointing the websites for the user get his better suited version of the compilation suite * Git is now optional. Further instructions is given about how to download the code manually without the need of Git. * Now the text is no longer "windows only" with instructions that can be used in Linux and MacOS too. --- README.md | 57 +++++++++++++++++++++++++------------------------------ 1 file changed, 26 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index fbb7096c7..9f94c0fc2 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,18 @@ -bsnes -===== +# bsnes ![bsnes logo](bsnes/target-bsnes/resource/logo.png) -**bsnes** is a multi-platform Super Nintendo (Super Famicom) emulator, originally +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. +features, and ease of use. -Community ---------- +## Community - [Official git repository](https://github.com/bsnes-emu/bsnes) - [Discussion Forum](https://helmet.kafuka.org/bboard/forum.php?id=6) - - [Discord Chat](https://discord.gg/xdsQRXfuCh) + - [![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?logo=discord)](https://discord.gg/B27hf27ZVf) -Unique Features ---------------- +## Unique Features - True Super Game Boy emulation (using the SameBoy core by Lior Halphon) - HD mode 7 graphics with optional supersampling (by DerKoun) @@ -31,8 +28,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 @@ -60,14 +56,12 @@ Standard Features - Multi-monitor support - Turbo support for controller inputs -Links ------ +## 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) @@ -75,30 +69,31 @@ Nightly Builds - ![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) -Compiling instructions (for Windows x64) ----------------------------------------- +## Compiling instructions If you want to compile by yourself, it's also very easy to. Just follow these steps: -1. You'll need both MinGW and .git installed in your system. If you already have, you can skip these steps: +### Prerequisites - I. Download MingGW x64 (http://mingw-w64.org/doku.php). Install and make sure that the following paths are in your enviroment table (you can check searching for "enviroment path" in your windows search and opening "Edit enviroment path"). - ![image](https://user-images.githubusercontent.com/12163923/128291920-11b92486-c765-4064-abc1-630164b9f1d8.png) - ![image](https://user-images.githubusercontent.com/12163923/128292012-590136b4-5e90-4518-ac58-1b07b6839533.png) - - II. Download and install git (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). - -2. Open a command prompt in your directory of choice and clone bsnes/higan/ares with the command: -`git clone https://github.com/bsnes-emu/bsnes.git` + * 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). -3. Go to `bsnes` folder with: `cd bsnes`. +### Generating the executable -4. Now you just need to put the command: `mingw32-make`. The compilation will start. +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` -5. The brand new compiled file will be at directory `./bsnes/out`. Enjoy! +2. Go to `bsnes` folder with: `cd bsnes`. -Preview -------- +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) From 80b53c2d1c67ba9b7b07dc91d587131f645fc6cb Mon Sep 17 00:00:00 2001 From: Shideravan Date: Sat, 21 Aug 2021 23:34:47 -0300 Subject: [PATCH 6/7] As asked, removing redundant section too --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 9f94c0fc2..2ad92bea1 100644 --- a/README.md +++ b/README.md @@ -56,11 +56,6 @@ features, and ease of use. - 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 - [Download](https://cirrus-ci.com/github/bsnes-emu/bsnes/master) From c1976866a9e8582a5780a8dd22f8bef0c1e24a0d Mon Sep 17 00:00:00 2001 From: Shideravan Date: Sat, 21 Aug 2021 23:39:14 -0300 Subject: [PATCH 7/7] Adding fancy license button It's linked with the bsnes license page --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2ad92bea1..be934c77d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 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