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.

Sign up for GitHub

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

Improve info about Carthage and contribution setup #658

Merged
merged 2 commits into from
Dec 1, 2017
Merged

Improve info about Carthage and contribution setup #658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b37faf7
README: improve info about Carthage and contribution setup
ricardopereira Dec 1, 2017
c3921f4
Example image about Carthage dependencies
ricardopereira Dec 1, 2017
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
Binary file added Examples/Images/linked-frameworks.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Add this line to your application's Cartfile:

And then run `carthage update` to build the framework and drag the built Ably.framework into your Xcode project.

If you see, for example, a `dyld: Library not loaded: @rpath/SocketRocket.framework/SocketRocket` error, then most likely you forgot to add all the dependencies to your project. You have more detailed information [here](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application).

![](Examples/Images/linked-frameworks.png)

### Manual installation

1. Get the code from GitHub [from the release page](https://github.com/ably/ably-ios/releases/tag/1.0.9), or clone it to get the latest, unstable and possibly underdocumented version: `git clone [email protected]:ably/ably-ios.git`
Expand Down Expand Up @@ -546,11 +550,12 @@ You can also view the [community reported Github issues](https://github.com/ably
## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Ensure you have added suitable tests and the test suite is passing
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
2. Install dependencies by running `pod install` and `carthage bootstrap`
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Ensure you have added suitable tests and the test suite is passing
6. Push to the branch (`git push origin my-new-feature`)
7. Create a new Pull Request

## Release Process

Expand Down
16 changes: 10 additions & 6 deletions Scripts/setup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@
# exit if a command fails
set -e

# Facebook Replacement for Apple's xcodebuild
brew update && brew install xctool

# Install Scan
gem install scan
# Install Fastlane
gem install fastlane

# Install CocoaPods
gem install cocoapods -v '0.39.0'
gem install cocoapods

# Install Carthage
brew update && brew install carthage

# Install dependencies
pod install
carthage bootstrap