Skip to content
This repository has been archived by the owner on Aug 3, 2021. It is now read-only.

docs: Update iOS install steps #37

Merged
merged 1 commit into from
Jan 12, 2021
Merged

docs: Update iOS install steps #37

merged 1 commit into from
Jan 12, 2021

Conversation

jakubkoci
Copy link
Contributor

Although I'm aware this is not the best way, It works for me. We can take it as a starting point and improve upon that.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@TimoGlastra TimoGlastra left a comment

Choose a reason for hiding this comment

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

Couple additional notes based on the merged version.

If you agree with the notes I can create an additional PR

pod install --project-directory=ios/
```

2. Create `Frameworks` folder in your project's `ios/Pods` directory and copy `Indy.frameworks` into that directory.
Copy link
Contributor

Choose a reason for hiding this comment

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

Indy.frameworks -> Indy.framework


2. Create `Frameworks` folder in your project's `ios/Pods` directory and copy `Indy.frameworks` into that directory.

3. Add `Indy.framework` as dependency into your project. Open `.xcworkspace` file in Xcode and in your project settings, tab General, section Frameworks, Libraries, and Embedded Content, click on plus. Then select Add Other -> Add files... and navigate to `Indy.framework` file on your disk. Beware that `Indy.framework` needs to be compiled with the same version of Swift as your project.
Copy link
Contributor

Choose a reason for hiding this comment

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

It is important to note that the file is not added to the gitignore. Otherwise you will need to do this after every clone

Copy link
Contributor

Choose a reason for hiding this comment

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

Also regarding the sentence:
"Beware that Indy.framework needs to be compiled with the same version of Swift as your project."

This is not true if "Indy.framework" is built with "Build Libraries for Distribution", which can be enabled by using:

Select framework target -> Build Settings -> Build Libraries for Distribution (BUILD_LIBRARY_FOR_DISTRIBUTION) -> Yes

See https://stackoverflow.com/a/63305234/10552895.

I think this is very useful to note

Comment on lines +137 to +147
4. Add `FRAMEWORK_SEARCH_PATHS` into `rn-indy-sdk.*.xcconfig`:

Debug build:
```bash
echo 'FRAMEWORK_SEARCH_PATHS = "${PODS_ROOT}/Frameworks"' >> ios/Pods/Target\ Support\ Files/rn-indy-sdk/rn-indy-sdk.debug.xcconfig
```

Release build:
```bash
echo 'FRAMEWORK_SEARCH_PATHS = "${PODS_ROOT}/Frameworks"' >> ios/Pods/Target\ Support\ Files/rn-indy-sdk/rn-indy-sdk.release.xcconfig
```

Choose a reason for hiding this comment

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

I've noticed that every time I add a React Native dependency that requires me to run pod install, these steps need to be repeated. I think the pod install command overwrites the indy-sdk.*.xcconfig files with the original files. Might be nice to add to the docs too :)

jakubkoci added a commit that referenced this pull request Jul 14, 2021
Signed-off-by: Jakub Koci <jakub.koci@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants