Updated README/COMPILING

This commit is contained in:
Sour 2023-02-05 12:02:18 -05:00
parent c80470e13f
commit c61cfae9b4
3 changed files with 23 additions and 14 deletions

View file

@ -1,15 +1,22 @@
### Windows
## Windows
1) Open the solution in Visual Studio 2022
2) Compile as Release/x64
3) Set the startup project to the "UI" project and run
2) Compile as `Release`/`x64`
3) Set the startup project to the `UI` project and run
### Linux
## Linux
To compile Mesen under Linux you will need a version of clang or gcc which supports C++17.
To build under Linux you need a version of Clang or GCC that supports C++17.
Additionally, the [.NET 6 SDK](https://learn.microsoft.com/en-us/dotnet/core/install/linux) must also be installed.
Additionally, SDL2 and the [.NET 6 SDK](https://learn.microsoft.com/en-us/dotnet/core/install/linux) must also be installed.
Examples:
`LTO=true make` will compile with clang and LTO.
`USE_GCC=true LTO=true make` will compile with gcc and LTO.
Once SDL2 and the .NET 6 SDK are installed, run `make` to compile with Clang.
To compile with GCC instead, use `USE_GCC=true make`.
**Note:** Mesen usually runs faster when built with Clang instead of GCC.
## macOS
To build macOS, install SDL2 (i.e via Homebrew) and the [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0).
Once SDL2 and the .NET 6 SDK are installed, run `make`.

View file

@ -1,6 +1,6 @@
# Mesen
Mesen is a multi-system emulator (NES, SNES, Game Boy and PC Engine) for Windows & Linux built in C++ and C#.
Mesen is a multi-system emulator (NES, SNES, Game Boy and PC Engine) for Windows, Linux and macOS built in C++ and C#.
## Releases
@ -18,9 +18,11 @@ Latest development builds:
## Requirements
**Windows**: .NET 6
**Linux**: .NET 6, SDL2
**macOS**: .NET 6, SDL2
To run Mesen, the following prerequisites must be installed:
**Windows**: [.NET 6 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
**Linux**: [.NET 6 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0), SDL2
**macOS**: [.NET 6 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0), SDL2
## Compiling

View file

@ -148,7 +148,7 @@ pgo:
./buildPGO.sh
run:
./UI/bin/$(MESENPLATFORM)/Release/$(MESENPLATFORM)/publish/Mesen
./bin/$(MESENPLATFORM)/Release/$(MESENPLATFORM)/publish/Mesen
clean:
rm -r -f $(COREOBJ)