README update

Minor cleanup such as capitalization fixes, wording changes, and punctuation tweaks.
2024-11-22 02:32:36 +01:00 · 2018-10-10 01:24:48 +00:00 · 2018-10-10 01:24:48 +00:00 · e52d338552
commit e52d338552
parent 83b6c98563
1 changed files with 14 additions and 14 deletions
--- a/README.md
+++ b/README.md
@ -6,15 +6,15 @@ RPCS3

 The world's first open-source PlayStation 3 emulator/debugger, written in C++ for Windows and Linux.

-You can find some basic information in our [**website**](https://rpcs3.net/). Game info is being populated on the [**wiki**](https://wiki.rpcs3.net/).
-For discussion about this emulator and PS3 emulation, or game compatibility reports, please visit our [**forums**](https://forums.rpcs3.net) and our [**Discord server**](https://discord.me/RPCS3).
+You can find some basic information on our [**website**](https://rpcs3.net/). Game info is being populated on the [**Wiki**](https://wiki.rpcs3.net/).
+For discussion about this emulator, PS3 emulation, and game compatibility reports, please visit our [**forums**](https://forums.rpcs3.net) and our [**Discord server**](https://discord.me/RPCS3).

 [**Support Lead Developers Nekotekina and kd-11 on Patreon**](https://www.patreon.com/Nekotekina)


 ## Development

-If you want to contribute please take a look at the [Coding Style](https://github.com/RPCS3/rpcs3/wiki/Coding-Style), [Roadmap](https://github.com/RPCS3/rpcs3/wiki/Roadmap) and [Developer Information](https://github.com/RPCS3/rpcs3/wiki/Developer-Information) pages. You should as well contact any of the developers in the forums or in Discord in order to know more about the current situation of the emulator.
+If you want to contribute, please take a look at the [Coding Style](https://github.com/RPCS3/rpcs3/wiki/Coding-Style), [Roadmap](https://github.com/RPCS3/rpcs3/wiki/Roadmap) and [Developer Information](https://github.com/RPCS3/rpcs3/wiki/Developer-Information) pages. You should also contact any of the developers in the forums or in the Discord server to learn more about the current state of the emulator.


 ## Dependencies
@ -48,7 +48,7 @@ MacOS is not supported at this moment because it doesn't meet system requirement


 ## Building on Windows:
-To initialize the repository don't forget to execute `git submodule update --init` to pull the submodules.
+To initialize the repository, don't forget to execute `git submodule update --init` to pull the submodules.

 ### Configuring the Qt plugin (if used)

@ -57,7 +57,7 @@ To initialize the repository don't forget to execute `git submodule update --ini

 ### Building the projects

-Open `rpcs3.sln`. The recommended build configuration is `Release - LLVM`, for all purposes.
+Open `rpcs3.sln`. The recommended build configuration is `Release - LLVM` for all purposes.

 You may want to download precompiled [LLVM libs](https://github.com/RPCS3/llvm/releases/download/continuous-master/llvmlibs.7z) and extract to root rpcs3 folder (which contains `rpcs3.sln`), as well as download and extract [additional libs](https://drive.google.com/uc?export=download&id=1A2eOMmCO714i0U7J0qI4aEMKnuWl8l_R) to `lib\%CONFIGURATION%-x64\` to speed up compilation time (unoptimised/debug libs are currently not available precompiled).

@ -77,12 +77,12 @@ If you're not using precompiled libs, build the projects in *__BUILD_BEFORE* fol
 - `cd rpcs3`
 - `git submodule update --init`
 - `cd ..`
-4) Configure and compile rpcs3
+4) Configure and compile RPCS3
 - `mkdir rpcs3_build && cd rpcs3_build`
 - `cmake -G "MSYS Makefiles" -DCMAKE_MAKE_PROGRAM=mingw32-make ../rpcs3/`
 - `mingw32-make.exe GitVersion && mingw32-make.exe discord-rpc`
 - If you use ```-DUSE_SYSTEM_FFMPEG=OFF```, run `mingw32-make ffmpeg-mingw`
-5) Build rpcs3
+5) Build RPCS3
 - Run `mingw32-make` or `mingw32-make -jX` where X is your CPU cores.
 6) Copy dependencies
 - `cd ./bin`
@ -105,7 +105,7 @@ If you're not using precompiled libs, build the projects in *__BUILD_BEFORE* fol
 4) `cmake ../rpcs3/ && make GitVersion && make`
 5) Run RPCS3 with `./bin/rpcs3`

-If you are on MacOS and want to build with brew llvm and qt don't forget to add the following environment variables
+If you are on MacOS and want to build with brew llvm and qt, don't forget to add the following environment variables:

 * `LLVM_DIR=/usr/local/opt/llvm/` (or wherever llvm was installed).
 * `Qt5_DIR=/usr/local/opt/qt/lib/cmake/Qt5` (or wherever qt was installed).
@ -116,23 +116,23 @@ When using GDB, configure it to ignore SIGSEGV signal (`handle SIGSEGV nostop no
 ## CMake Build Options (Linux & Mac OS)

 - ```-DUSE_SYSTEM_LIBPNG=ON/OFF``` (default = *OFF*)
-Build against the shared libpng instead of using the builtin one. libpng 1.6+ highly recommended. Try this option if you get version conflict errors or only see black game icons.
+Build against the shared libpng instead of using the built-in one. libpng 1.6+ highly recommended. Try this option if you get version conflict errors or only see black game icons.

 - ```-DUSE_SYSTEM_FFMPEG=ON/OFF``` (default = *OFF*)
-Build against the shared ffmpeg libraries instead of using the builtin patched version. Try this if the builtin version breaks the OpenGL renderer for you.
+Build against the shared ffmpeg libraries instead of using the built-in patched version. Try this if the built-in version breaks the OpenGL renderer for you.

 - ```-DWITHOUT_LLVM=ON/OFF``` (default = *OFF*)
-This forces RPCS3 to build without LLVM, not recommended.
+This forces RPCS3 to build without LLVM (not recommended).

 - ```-DWITH_GDB=ON/OFF``` (default = *OFF*)
-This Builds RPCS3 with support for debugging PS3 games using gdb.
+This builds RPCS3 with support for debugging PS3 games using gdb.

 - ```-DUSE_VULKAN=ON/OFF``` (default = *ON*)
 This builds RPCS3 with Vulkan support.

 - ```-DUSE_NATIVE_INSTRUCTIONS=ON/OFF``` (default = *ON*)
-This builds rpcs3 with -march=native, which is useful for local builds, but not good for packages.
+This builds RPCS3 with -march=native, which is useful for local builds, but not good for packages.

 ## License

-Most files are licensed under the terms of GNU GPLv2 License, see LICENSE file for details. Some files may be licensed differently, check appropriate file headers for details.
+Most files are licensed under the terms of GNU GPLv2 License; see LICENSE file for details. Some files may be licensed differently; check appropriate file headers for details.