Minor documentation improvements

Author: ppoelzl

CONTRIBUTING.md

@@ -1,11 +1,13 @@
-### Instructions to build a DLL
-1. Check out git to a new folder
-2. Open VS2019
+## Instructions to build a DLL
+
+1. Check out `git` to a new folder
+2. Open Visual Studio 2019
 3. Choose the "Open a folder" option and choose the git checkout
 4. In the configurations dropdown, choose "Manage configurations..."
-5. Add a new x86-Release configuration and save the CMakeSettings.json file
-6. Choose this new x86-Release configuration in the configurations dropdown
-7. Go to Build->Build All and wait for the build to complete with no errors
-8. Find the new dll in out\build\x86-Release\SimpleGraphic.dll
+5. Add a new "Release|x86" configuration and save the `CMakeSettings.json` file
+6. Choose this new "Release|x86" configuration in the configurations dropdown
+7. Go to "Build" > "Build All" and wait for the build to complete without errors
+8. Find the new DLL in `out\build\x86-Release\SimpleGraphic.dll`
 
-To use this DLL, simply copy it to your Path Of Building install location and restart Path Of Building
+To use this DLL, simply copy it to your Path Of Building install location and
+restart Path Of Building.

DEPENDENCIES.md

@@ -1,10 +1,14 @@
-# Dependencies for SimpleGraphics
+# Dependencies for SimpleGraphic
 
-There are several 3rd party (open source) dependencies for building the SimpleGraphics.dll library used by Path of Building. To build the library yourself, you will need to acquire these libraries.
+There are several 3rd-party (open source) dependencies for building the
+SimpleGraphic.dll library used by Path of Building.
+To build the library yourself, you will need to acquire these libraries.
 
 ## List of Libraries
 
-The following 3rd party libraries are required to build SimpleGraphics.dll. Usually, the latest version will work, but the most recent version used by the PathOfBuildingCommunity team are as follows:
+The following 3rd-party libraries are required to build SimpleGraphic.dll.
+Usually, the latest version will work, but the most recent version used by the
+PathOfBuildingCommunity org are as follows:
 * LuaJIT 2.0.5-3
 * zlib 1.2.11-6
 * libjpeg-turbo 2.0.4
@@ -13,16 +17,21 @@ The following 3rd party libraries are required to build SimpleGraphics.dll. Usua
 * tiff 4.0.10-9
 * liblzma 5.2.4-5
 
-These libraries are also listed in vcpkg.txt for our GitHub actions build to reference
+These libraries are also listed in vcpkg.txt
+for our GitHub actions build to reference.
 
-## Using vcpgk to install dependencies on Windows for building with Visual Studio
+## Build SimpleGraphic on Windows with Visual Studio and vcpkg
 
-vcpgk is an open-source tool by Microsoft which can easily download and build all of the required dependencies. This is the recommended method for retrieving the dependencies when building for Visual Studio.
-vcpkg is included as a submodule of this project, so installing it should be relatively simple
+vcpgk is an open-source tool by Microsoft which can easily download and build
+all of the required dependencies. This is the recommended method for retrieving
+the dependencies when building for Visual Studio.
+vcpkg is included as a submodule of this project,
+so installing it should be relatively simple.
 
 1) Run 'git submodule update --init'
 2) 'cd vcpkg'
 3) Type the following commands:
    1) `bootstrap-vcpkg.sh` or `bootstrap-vcpkg.bat`
    2) `./vcpkg.exe install @../vcpkg.txt` or `vcpkg install @../vcpkg.txt`
-4) The SimpleGraphics solution and vcproj are already configured to look in this location for the dependencies, so it should now build as-is.
+4) The SimpleGraphic solution and vcproj are already configured to look in this
+location for the dependencies, so now it should build as-is.

README.md

@@ -2,30 +2,43 @@
 
 ## Introduction
 
-SimpleGraphic.dll is the host environment for Lua. It contains the API used by the application's Lua logic, as well as a 2D OpenGL renderer, window management, input handling, and a debug console. It exports one symbol, RunLuaFileAsWin, which is passed a C-style argc/argv argument list, with the script path as argv[0].
+`SimpleGraphic.dll` is the host environment for Lua.
+It contains the API used by the application's Lua logic, as well as a 2D OpenGL
+renderer, window management, input handling, and a debug console.
+It exports one symbol, `RunLuaFileAsWin`, which is passed a
+C-style argc/argv argument list, with the script path as `argv[0]`.
 
 The Windows-specific code is contained in 5 files:
-- win\entry.cpp: Contains the DLL export. It just creates the system main module, and runs it.
-- engine\system\win\sys_main.cpp: The system main module; it initialises the application, and contains generic OS interface functions, such as input and clipboard handling.
-- engine\system\win\sys_console.cpp: Manages the debug console window that appears during the program's initialisation.
-- engine\system\win\sys_video.cpp: Creates and manages the main program window.
-- engine\system\win\sys_opengl.cpp: Initialises OpenGL.
+- `win\entry.cpp`: Contains the DLL export
+It just creates the system main module, and runs it
+- `engine\system\win\sys_main.cpp`: The system main module.
+It initialises the application, and contains generic OS interface functions,
+such as input and clipboard handling
+- `engine\system\win\sys_console.cpp`: Manages the debug console window that
+appears during the program's initialisation
+- `engine\system\win\sys_video.cpp`: Creates and manages the main program window
+- `engine\system\win\sys_opengl.cpp`: Initialises OpenGL
 
 ## Building
 
-SimpleGraphic.dll is currently built using Visual Studio 2019.
+`SimpleGraphic.dll` is currently built using Visual Studio 2019.
 
-The dll depends on a number of 3rd party libraries. Details and instructions for how to obtain them are in DEPENDENCIES.md.
+The DLL depends on a number of 3rd-party libraries. Details and instructions
+for how to obtain them are in [DEPENDENCIES.md](DEPENDENCIES.md).
 
 Once the libraries are obtained, follow these instructions to build the DLL:
-1) Open SimpleGraphic.sln in Visual Studio 2019
-2) Choose the `Release|x86` configuration.
+1) Open `SimpleGraphic.sln` in Visual Studio 2019
+2) Choose the "Release|x86" configuration
 3) Build the solution
-4) The resulting `SimpleGraphic.dll` can be found in the `Release` directory.
-5) Copy `SimpleGraphic.dll` to the Path of Building install directory, replacing the existing file.
+4) The resulting `SimpleGraphic.dll` can be found in the `Release` directory
+5) Copy `SimpleGraphic.dll` to the Path of Building install directory,
+replacing the existing file.
 
 ## Debugging
 
-Since SimpleGraphic.dll is dynamically loaded by `PathOfBuilding.exe`, to debug it, run `PathOfBuilding.exe` and then attach to that process using the `Debug->Attach to Process...` menu option in Visual Studio.
+Since SimpleGraphic.dll is dynamically loaded by `PathOfBuilding.exe`,
+to debug it, run `PathOfBuilding.exe` and then attach to that process using the
+"Debug" > "Attach to Process..." menu option in Visual Studio.
 
-If debugging of the initialization is desired, then adding a MessageBox or some other pause at the start will give you time to attach and continue.
+If debugging of the initialization is desired, then adding a `MessageBox`
+or some other pause at the start will give you time to attach and continue.