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

Playground build steps / typos / formatting #2930

Merged
merged 2 commits into from
May 24, 2016
Merged

Playground build steps / typos / formatting #2930

merged 2 commits into from
May 24, 2016

Conversation

tomj
Copy link
Contributor

@tomj tomj commented May 23, 2016

As discussed on #2916 let's add instructions for how to build the project and run the playground. Another teeny commit to nix a couple of typos and formatting issues.

@@ -1,11 +1,15 @@
/*:
> # IMPORTANT: To use `ReactiveCocoa.playground`, please:

1. Open `ReactiveCocoa.xcworkspace`
Copy link
Contributor

@iv-mexx iv-mexx May 23, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, now I understand the Problem in #2916. I was confused because the Playground instructions in the Readme already state that you need to run script/bootstrap.
Maybe you could also update the instructions in the Readme

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iv-mexx yeah I didn't quite understand it myself at first either. 3066cf2 brings the playground instructions in the main README up to date with the new playground steps

@RuiAAPeres
Copy link
Member

Adding context to this, when I started creating the playground, I took a lot of inspiration from what was done in the RxSwift playground. Since it look and felt good I went with that approach.

@tomj
Copy link
Contributor Author

tomj commented May 23, 2016

@RuiAAPeres I think it's perfectly reasonable to keep it similar to the RxSwift playground (at least for now until there's a better format proposed). And looks like we can remove the Build Result-Mac line as pointed out by @ikesyo

@RuiAAPeres
Copy link
Member

@tomj depends. If I clean the derived data, I need to build each dependency again. I think it's useful to keep that there at least as a reminder.

@tomj
Copy link
Contributor Author

tomj commented May 23, 2016

@RuiAAPeres rock and roll, I'll leave it in 😀 I'll squash all of these commits and force push to my branch now

- Tell users to grab the project dependencies before
  trying to run the playgrounds
- Update the README playground instructions to
  match those in the playgrounds themselves
- Fix a typo and update the formatting in the 
  playground instructions
@ikesyo
Copy link
Member

ikesyo commented May 23, 2016

If I clean the derived data, I need to build each dependency again.

I'm not sure. Xcode should detect the case and automatically rebuild the dependencies too, I think.

@ikesyo
Copy link
Member

ikesyo commented May 23, 2016

Even if we leave the Result step, that should be placed before ReactiveCocoa. Let's build the dependencies first.

@tomj
Copy link
Contributor Author

tomj commented May 23, 2016

As you wish - e3c3f8d. @RuiAAPeres fwiw just then I took a look and if I delete my derived data folder and then rebuild only ReactiveCocoa-Mac then my Build/Products/Debug contains ReactiveCocoa and Result frameworks. Either way I don't think it hurts to have this here as it's instructive as much as anything else (and the way 3rd party frameworks are handled in playgrounds seems to be quite fragile at the best of times so being over cautious could be prudent).

@mdiep
Copy link
Contributor

mdiep commented May 24, 2016

Thanks @tomj!

@mdiep mdiep merged commit b47a2dd into ReactiveCocoa:master May 24, 2016
@tomj tomj deleted the playground_build_steps_typos_formatting branch May 25, 2016 01:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants