Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Getting Started Section #270

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,29 @@ Mockingbird makes it easy to mock, stub, and verify objects in Swift unit tests.

Visit [MockingbirdSwift.com](https://mockingbirdswift.com) for quick start guides, walkthroughs, and API reference articles.

## Getting Started
1. Add Mockingbird as a dependency using your favorite dependency manager
2. Look for mockingbird shell script in the dependency files
3. Drag & drop the shell script into the terminal
4. With the shell path written in the terminal, add the following ` configure {Test Target} -- --target {Main Target}`

<details>
<summary>Hint</summary>


```console
/path/to/mockingbird configure MockingbirdWalkthroughTests -- --target MockingbirdWalkthrough
```

</details>

5. Get back to Xcode
6. Hit `⇧⌘U`
7. Now you're ready to start using the framework


> Still struggling? Check out [this video](https://youtu.be/vBFVzMFzl3s) then.

## Examples

Automatically generating mocks.
Expand Down