Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
D0miH authored Oct 19, 2020
1 parent 3a0fe71 commit bf1f359
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,20 @@ git clone --recurse-submodules [email protected]:iglance/iGlance.git

## Installing the dependencies

After cloning your forked repository you have to install the dependencies of the project using [CocoaPods](https://cocoapods.org) and [Carthage](https://github.com/Carthage/Carthage). To install the dependencies using both dependency managers you can execute the following command (including the parantheses) in the root directory of the cloned repository:
After cloning your forked repository you have to install the dependencies of the project using [CocoaPods](https://cocoapods.org) and [Carthage](https://github.com/Carthage/Carthage). To install the dependencies using both dependency managers you can execute the following command (including the parantheses) in the root directory (in the following called `<root>`) of the cloned repository:

```
(cd ./iGlance && pod install && cd ./iGlance && carthage update)
```

If you get an error during building the carthage libraries [this](https://stackoverflow.com/questions/40743713/command-line-tool-error-xcrun-error-unable-to-find-utility-xcodebuild-n) might help you.

## Setting up Xcode
To get started using Xcode you need to open the workspace file `<root>/iGlance/iGlance.xcworkspace`. To test if everything is setup correctly you can select the `iGlance` scheme at the upper left corner and run the app by clicking `Product > Run`. The app should be built now and start running.
To setup Xcode correctly with CocoaPods you should see a warning saying `"Update to recommended settings"`. By clicking on the warning and letting Xcode automatically update the project settings should fix the warning.

Now you are ready to start developing!🎉

## Getting ready for development

We have a `master` and a `development` branch in this repository. The `master` branch is responsible for all the releases. We push to this branch only if we release a new version. The development (as the name suggests) is for developing.
Expand Down

0 comments on commit bf1f359

Please sign in to comment.