Add hero image to README and migrate project documentation to wiki (#84)

typealiased · Apr 21, 2020 · 44241e2 · 44241e2
1 parent eb247c7
commit 44241e2
Show file tree

Hide file tree

Showing 13 changed files with 57 additions and 404 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -18,20 +18,23 @@ Please provide a clear and concise description of the bug.
 
 ### Generator Bugs
 
-Please provide the complete output when running Mockingbird CLI, including any options used.
-
-```bash
-$ mockingbird generate
-```
-
 If the generator produces code that is malformed or does not compile, please provide:
+
 1. A minimal example of the original source
 2. The actual mocking code generated
 3. The expected mocking code that should be generated (or a description)
 
+If the generator is not producing code or crashing, please provide logging output from the Run Script Phase. See
+[Debugging the generator](https://github.com/birdrides/mockingbird/wiki/Debugging-the-Generator) for more 
+information.
+
+```bash
+$ mockingbird generate
+```
+
 ### Framework Bugs
 
-Please provide a minimal example of your unit testing code, including any errors.
+Please provide a minimal example of your testing code, including any errors.
 
 ## Environment
 
@@ -41,3 +44,4 @@ Please provide a minimal example of your unit testing code, including any errors
 * Installation method (CocoaPods, Carthage, from source, etc)
 * Unit testing framework (XCTest, Quick + Nimble, etc)
 * Does your project use `.mockingbird-ignore`?
+* Are you using [supporting source files](https://github.com/birdrides/mockingbird#supporting-source-files)?
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,37 +9,3 @@ Install required dependencies and configure the Xcode project.
 ```bash
 $ make setup-project
 ```
-
-## Project Structure
-
-### MockingbirdCli
-
-Frontend for the CLI which uses the argument parser from `SPMUtility`.
-
-### MockingbirdGenerator
-
-Performs code generation for a target.
-
-1. Parse the Xcode project using `XcodeProj`, or used a cached representation of the Xcode project.
-2. Extract the source files from the target and its dependencies.
-3. Parse each extracted source file into a structure tree using `SourceKitten`.
-4. Minimally process the top level types from each structure tree, converting them into a  `RawType`.
-5. For each `RawType` coming from a target-defined source file, flatten the inheritance graph into a `MockableType`.
-6. Send all `MockableType` objects to the generator to render using templates.
-
-### MockingbirdFramework
-
-The runtime testing framework that provides mocking, stubbing, and verification APIs.
-
-### MockingbirdTestsHost
-
-Defines types used in end-to-end tests.
-
-### MockingbirdModuleTestsHost
-
-Defines types which are imported by `MockingbirdTestsHost` and used for cross-module end-to-end tests. 
-
-### MockingbirdTests
-
-Handles end-to-end and unit tests. End-to-end tests use protocol conformance for asserting that generated mocks
-contain the expected member declarations.
diff --git a/Codesigning/README.md b/Codesigning/README.md
diff --git a/Documentation/Assets/signed-cli-installer.png b/Documentation/Assets/signed-cli-installer.png
diff --git a/Documentation/Assets/test-target-build-phases.png b/Documentation/Assets/test-target-build-phases.png
diff --git a/Documentation/LinkingTestTargets.md b/Documentation/LinkingTestTargets.md
diff --git a/Documentation/ManualSetup.md b/Documentation/ManualSetup.md
diff --git a/Documentation/MockingExternalTypes.md b/Documentation/MockingExternalTypes.md
diff --git a/Documentation/Performance.md b/Documentation/Performance.md
diff --git a/Examples/iOSMockingbirdExample-Carthage/README.md b/Examples/iOSMockingbirdExample-Carthage/README.md
@@ -75,11 +75,11 @@ Open the Xcode project.
 $ open iOSMockingbirdExample-Carthage.xcodeproj
 ```
 
-Take a peek at the example test and sources and then run the tests (⌘+U).:
+Take a peek at the example test and sources and then run the tests (⌘+U):
 
 - [`TreeTests.swift`](iOSMockingbirdExample-CarthageTests/TreeTests.swift)
 - [`Tree.swift`](iOSMockingbirdExample-Carthage/Tree.swift)
 - [`Bird.swift`](iOSMockingbirdExample-Carthage/Bird.swift)
 
 Bonus: look at the contents of 
-[`.mockingbird-ignore`](iOSMockingbirdExample-CarthageTests/.mockingbird-ignore). 
+[`.mockingbird-ignore`](iOSMockingbirdExample-Carthage/.mockingbird-ignore). 
diff --git a/Examples/iOSMockingbirdExample-CocoaPods/README.md b/Examples/iOSMockingbirdExample-CocoaPods/README.md
@@ -67,11 +67,11 @@ Open the Xcode workspace generated by CocoaPods.
 $ open iOSMockingbirdExample-CocoaPods.xcworkspace
 ```
 
-Take a peek at the example test and sources and then run the tests (⌘+U).:
+Take a peek at the example test and sources and then run the tests (⌘+U):
 
 - [`TreeTests.swift`](iOSMockingbirdExample-CocoaPodsTests/TreeTests.swift)
 - [`Tree.swift`](iOSMockingbirdExample-CocoaPods/Tree.swift)
 - [`Bird.swift`](iOSMockingbirdExample-CocoaPods/Bird.swift)
 
 Bonus: look at the contents of 
-[`.mockingbird-ignore`](iOSMockingbirdExample-CocoaPodsTests/.mockingbird-ignore). 
+[`.mockingbird-ignore`](iOSMockingbirdExample-CocoaPods/.mockingbird-ignore). 
diff --git a/Images/mockingbird-hero-image.png b/Images/mockingbird-hero-image.png