Merge pull request #48 from XDelta/master

Assorted small tweaks to the docs

Author: zkxs

README.md

@@ -7,7 +7,7 @@ A mod loader for [Neos VR](https://neos.com/). Consider joining our community on
 If you are using the Steam version of Neos you are in the right place. If you are using the standalone version, read the [Neos Standalone Setup](doc/neos_standalone_setup.md) instructions. If you are on Linux, read the [Linux Notes](doc/linux.md).
 
 1. Download [NeosModLoader.dll](https://github.com/neos-modding-group/NeosModLoader/releases/latest/download/NeosModLoader.dll) to Neos's `Libraries` folder (`C:\Program Files (x86)\Steam\steamapps\common\NeosVR\Libraries`).
-2. Place [0Harmony.dll](https://github.com/neos-modding-group/NeosModLoader/releases/download/1.9.1/0Harmony.dll) into a `nml_libs` folder under your Neos install directory (`C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_libs`).
+2. Place [0Harmony.dll](https://github.com/neos-modding-group/NeosModLoader/releases/download/1.9.1/0Harmony.dll) into a `nml_libs` folder under your Neos install directory (`C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_libs`). You will need to create this this folder.
 3. Add mod DLL files to a `nml_mods` folder under your Neos install directory (`C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_mods`). You can create the folder if it's missing, or simply launch Neos once with NeosModLoader installed and it will be created automatically.
 4. Add the following to Neos's [launch options](https://wiki.neos.com/Command_Line_Arguments): `-LoadAssembly Libraries\NeosModLoader.dll`, substituting the path for wherever you put `NeosModLoader.dll`.
 5. Start the game. If you want to verify that NeosModLoader is working you can check the Neos logs. (`C:\Program Files (x86)\Steam\steamapps\common\NeosVR\Logs`). The modloader adds some very obvious logs on startup, and if they're missing something has gone wrong. Here is an [example log file](doc/example_log.log) where everything worked correctly.
@@ -72,7 +72,7 @@ Third-party libraries distributed alongside NeosModLoader:
 Third-party libraries used in source:
 
 - [.NET](https://github.com/dotnet) (Various licenses)
-- [Neos VR](https://neos.com/) ([EULA](https://store.steampowered.com//eula/740250_eula_0))
+- [Neos VR](https://neos.com/) ([EULA](https://store.steampowered.com/eula/740250_eula_0))
 - [Json.NET](https://github.com/JamesNK/Newtonsoft.Json) ([MIT License](https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md))
 
 <!--- Link References -->

doc/config.md

@@ -170,7 +170,7 @@ There are two cases to consider:
 
 | Action | Forwards Compatible | Backwards Compatible |
 | ------ | ------------------- | ---------------------|
-| Adding a brand new key | Yes | Yes |
+| Adding a brand-new key | Yes | Yes |
 | Removing an existing key | Yes | Yes |
 | Adding, altering, or removing a key's default value | Yes | Maybe* |
 | Restricting a key's validator | Yes** | Yes |

doc/directories.md

@@ -4,7 +4,7 @@ If you've installed to a non-default location then finding the path is up to you
 
 | Directory | Description |
 | --------- |------------ |
-| Neos Install Directory | Contains the game install itself, the log directory, and the libraries directory |
+| Neos Install Directory | Contains the game install itself, the log directory, and the `Libraries` directory |
 | Log Directory | A `Logs` directory within the Neos Install Directory. Contains the main game logs. |
 | Libraries Directory | A `Libraries` directory within the  Neos Install Directory. Plugins dlls go here.
 | Data Directory | Contains the local db, Unity's player.log, and local assets directory. Location can be changed with `-DataPath <path>` argument. |

doc/how_nml_works.md

@@ -6,7 +6,7 @@ NeosModLoader only interfaces with Neos in two places: the hook and the compatib
 
 The hook is the point where Neos "hooks" into NeosModLoader, allowing it to begin execution.
 
-Typically, [plugins] use [components] to execute custom code. This is limiting as they can only begin execution once a world loads. Typically this involves putting a plugin's component into your local home.
+Typically, [plugins] use [components] to execute custom code. This is limiting as they can only begin execution once a world loads. This usually involves putting a plugin's component into your local home.
 
 The NeosModLoader plugin uses a different mechanism. Instead of using a component, it uses a connector. Neos loads connectors during its initial setup, at which point they can begin execution. As this system is independent of world loading it is more reliable. The connector implementation is in [ExecutionHook.cs](../NeosModLoader/ExecutionHook.cs).