From 6dda53e84f7200283351a9514b0db569360dbe1a Mon Sep 17 00:00:00 2001 From: uranuspucksaxophone <84784521+uranuspucksaxophone@users.noreply.github.com> Date: Fri, 9 Sep 2022 18:39:23 +0200 Subject: [PATCH] Improve docs (#216) --- BUILD.md | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/BUILD.md b/BUILD.md index 8aa58b7b..67f55a94 100644 --- a/BUILD.md +++ b/BUILD.md @@ -14,7 +14,7 @@ Instructions: 2. Launch `Cemu/generate_vs_solution.bat`. - If you installed VS to a custom location or use VS 2019, you may need to manually change the path inside the .bat file 3. Wait until it's done, then open `Cemu/build/Cemu.sln` in Visual Studio -4. Then build the solution and once finished you can run and debug it, or build it and check the /bin folder for the final Cemu.exe. +4. Then build the solution and once finished you can run and debug it, or build it and check the /bin folder for the final Cemu_release.exe. You can also skip steps 3-5 and open the root folder of the cloned repo directly in Visual Studio (as a folder) and use the built-in cmake support but be warned that cmake support in VS can be a bit finicky. @@ -42,7 +42,7 @@ Additionally, for ubuntu 20.04 only: 2. `cd Cemu` 3. `cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -G Ninja` 4. `cmake --build build` -5. You should now have a Cemu executable file in the /bin folder, which you can run using `./bin/Cemu`. +5. You should now have a Cemu executable file in the /bin folder, which you can run using `./bin/Cemu_release`. #### Using GCC While we use and test Cemu using clang, using GCC might work better with your distro (they should be fairly similar performance/issues wise and should only be considered if compilation is the issue). diff --git a/README.md b/README.md index 6aff523c..b948b10c 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Cemu is currently only available for 64-bit Windows and Linux devices. ## Download -You can download the latest Cemu releases from the [Github Releases](https://github.com/cemu-project/Cemu/releases/) or from [Cemu's website](https://cemu.info). +You can download the latest Cemu releases from the [GitHub Releases](https://github.com/cemu-project/Cemu/releases/) or from [Cemu's website](https://cemu.info). Cemu is currently only available in a portable format so no installation is required besides extracting it in a safe place. @@ -36,7 +36,7 @@ To compile Cemu yourself on Windows or Linux, view the [BUILD.md file](/BUILD.md ## Issues -Issues with the emulator should be filed using [Github Issues](https://github.com/cemu-project/Cemu/issues). +Issues with the emulator should be filed using [GitHub Issues](https://github.com/cemu-project/Cemu/issues). The old bug tracker can be found at [bugs.cemu.info](https://bugs.cemu.info) and still contains relevant issues and feature suggestions. ## Contributing