From 7e3ffca36ba17d44ed6f996e5f1536b5035e41ae Mon Sep 17 00:00:00 2001 From: Aurumaker72 <48759429+Aurumaker72@users.noreply.github.com> Date: Tue, 10 Dec 2024 22:58:36 +0100 Subject: [PATCH] Update README.md --- README.md | 33 +-------------------------------- 1 file changed, 1 insertion(+), 32 deletions(-) diff --git a/README.md b/README.md index e2ef880e..5ba3abfe 100644 --- a/README.md +++ b/README.md @@ -26,35 +26,4 @@ If any issues arise or you need help, join the [discord server](https://discord. Cutting-edge features with potential instability are available for download as a zipped binary under the latest commit's artifact. -# Compiling - -Open the [solution](https://github.com/mkdasher/mupen64-rr-lua-/blob/dev/winproject/mupen64/mupen64_2017.sln) with your IDE of choice (VS20XX and Rider are recommended) and build the solution. - - -For Rider users: - - -It's recommended to disable "Use external console" (Run > Modify Run Configuration...), as it breaks spdlog's text coloring and reduces both startup and runtime performance. - -# Structure - -The project is divided into 3 layers: Shared, Core, and View. - -## Shared - -The shared layer contains code with no dependencies other than the STL and project libraries (e.g.: libdeflate). - -This layer contains shared code, such as helpers, contracts, core types, and the config. -All other layers can reference the shared layer and utilize its code, hence the name. - -## Core - -The core layer contains the emulation core data and code, with access to the shared layer, STL, and project libraries. - -This layer must be driven by the view layer, and is allowed to call into contract functions defined in the shared layer and implemented in the view layer. - -## View - -The view layer contains references to the other layers, implements the required contracts, and drives the view layer. - -Platform-specific references (e.g.: Windows.h) are only permitted in the view layer. +Visit the [Mupen64 Wiki](https://github.com/mkdasher/mupen64-rr-lua-/wiki/Contributing) for documentation!