make instructions easier to read and use, add instructions for running from source

Author: designatednerd

docs/source/api-reference.md

@@ -17,20 +17,59 @@ To run the document generator, make sure you have [SourceDocs](https://github.co
 brew install sourcedocs
 ```
 
+>**NOTE**: We are currently depending on functionality added in [this PR](https://github.com/eneko/SourceDocs/pull/20), so if that's not merged, and pushed as a new version to Homebrew, you'll need to check out from source. 
+
+## Homebrew Instructions
+
 To generate docs for the main `Apollo` project, `cd` into the source root and run: 
 
 ```
-sourcedocs generate --output-folder "docs/source/api/Apollo" -- -scheme Apollo -workspace Apollo.xcworkspace
+sourcedocs generate \
+    --output-folder "docs/source/api/Apollo" \
+    --link-ending "/" \
+    -- \
+    -scheme Apollo \
+    -workspace Apollo.xcworkspace
 ```
 
 To generate docs for the `ApolloSQLite` project, `cd` into the source root and run: 
 
 ```
-sourcedocs generate --output-folder "docs/source/api/ApolloSQLite" -- -scheme ApolloSQLite -workspace Apollo.xcworkspace
+sourcedocs generate \
+    --output-folder "docs/source/api/ApolloSQLite" \
+    --link-ending "/" \
+    -- \
+    -scheme ApolloSQLite \
+    -workspace Apollo.xcworkspace
 ```
 
 To generate for docs the `ApolloWebSocket` project, `cd` into the source root and run: 
 
 ```
-sourcedocs generate --output-folder "docs/source/api/ApolloWebSocket" -- -scheme ApolloWebSocket -workspace Apollo.xcworkspace
+sourcedocs generate \
+    --output-folder "docs/source/api/ApolloWebSocket" \
+    --link-ending "/" \
+    -- \
+    -scheme ApolloWebSocket \
+    -workspace Apollo.xcworkspace
 ```
+
+## From Source Instructions
+
+Commands are essentially the same except for the following differences: 
+
+- All commands should start with `swift run sourcedocs` instead of just `sourcedocs`
+- Add an `--input-folder` parameter with the full path to the Apollo `SRCROOT` as its value
+- Make the value of `--output-folder`'s parameter use a full path rather than a relative one.
+
+For example, this will run the generator for `ApolloWebSocket`:
+
+``` 
+swift run sourcedocs generate \
+    --input-folder "/Users/[you]/apollo-ios" \
+    --output-folder "/Users/[you]/apollo-ios/docs/source/api/ApolloWebSocket" \
+    --link-ending "/" \
+    -- \
+    -scheme "ApolloWebSocket" \
+    -workspace "Apollo.xcworkspace"
+```