Add documentation

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Nelson Gomez (simmaster07)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+# SC4MacInjector :electric_plug:
+A plugin for enabling Macs to run plugins for SimCity 4.
+
+## Requirements
+A digital release of SimCity 4 Deluxe/Rush Hour for Intel Macs (e.g. GOG, Steam, Origin).
+The Mac App Store release **will not work** as it is not Aspyr's port but a Wineskin wrapper.
+The PowerPC port is also incompatible, and since it is an unsupported platform it will not be
+implemented in the future.
+
+## Installation
+Either obtain a prebuilt .dylib file from the Releases tab or compile yourself, then copy to
+`~/Documents/SimCity 4/Plugins/`.
+
+## Usage
+Packaging is currently a work in progress. To use this plugin,
+
+1. Open a terminal.
+2. Run the following commands:
+
+```
+cd "~/Library/Application Support/Steam/steamapps/common/SimCity 4 Deluxe/SimCity 4 Deluxe Edition.app/Contents/MacOS"
+DYLD_INSERT_LIBRARIES=~/Documents/SimCity 4/Plugins/libinjector.dylib "./Sim City 4 Deluxe Editionsub"
+```
+
+On platforms other than Steam the path to `cd` into may differ, as may the name of the executable.

injector.xcodeproj/project.pbxproj

@@ -12,6 +12,7 @@
 		52D3506A1FEF564700177E88 /* rd_route.h in Headers */ = {isa = PBXBuildFile; fileRef = 52D350681FEF564700177E88 /* rd_route.h */; };
 		52D3506C1FEF5EF300177E88 /* incompat_msg.mm in Sources */ = {isa = PBXBuildFile; fileRef = 52D3506B1FEF5EF300177E88 /* incompat_msg.mm */; };
 		52D3506F1FEF68AC00177E88 /* Cocoa.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 52D3506E1FEF68AB00177E88 /* Cocoa.framework */; };
+		52D350741FEFA2BD00177E88 /* README.md in Sources */ = {isa = PBXBuildFile; fileRef = 52D350731FEFA2BD00177E88 /* README.md */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
@@ -28,6 +29,8 @@
 		52D3506E1FEF68AB00177E88 /* Cocoa.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Cocoa.framework; path = System/Library/Frameworks/Cocoa.framework; sourceTree = SDKROOT; };
 		52D350701FEF947C00177E88 /* cRZString.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = cRZString.h; sourceTree = "<group>"; };
 		52D350711FEF95FD00177E88 /* cIGZString.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = cIGZString.h; sourceTree = "<group>"; };
+		52D350721FEFA29E00177E88 /* LICENSE */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = LICENSE; sourceTree = "<group>"; };
+		52D350731FEFA2BD00177E88 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -45,6 +48,8 @@
 		52D3504B1FEEF12A00177E88 = {
 			isa = PBXGroup;
 			children = (
+				52D350731FEFA2BD00177E88 /* README.md */,
+				52D350721FEFA29E00177E88 /* LICENSE */,
 				52D3506E1FEF68AB00177E88 /* Cocoa.framework */,
 				52D350561FEEF12A00177E88 /* injector */,
 				52D350551FEEF12A00177E88 /* Products */,
@@ -146,6 +151,7 @@
 			files = (
 				52D3505C1FEEF12A00177E88 /* injector.cpp in Sources */,
 				52D350691FEF564700177E88 /* rd_route.c in Sources */,
+				52D350741FEFA2BD00177E88 /* README.md in Sources */,
 				52D3506C1FEF5EF300177E88 /* incompat_msg.mm in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;