Skip to content

Commit b34cb69

Browse files
authored
[v9] Improve clarity of zip integration instructions (#9720)
* [skip ci] Update zip README * [skip ci] Update zip README (2)
1 parent e3279d3 commit b34cb69

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

ReleaseTooling/Template/README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ To integrate a Firebase SDK with your app:
2424
want the framework to be added to has a checkmark next to it, and that
2525
you've selected "Copy items if needed".
2626

27-
*To disable AdId support, do not copy
28-
`GoogleAppMeasurementIdentitySupport.xcframework`.*
27+
> To disable AdId support, do not copy
28+
> `GoogleAppMeasurementIdentitySupport.xcframework`.
2929
30-
*If the app does not use any Firebase Swift specific APIs, you do not need
31-
to copy any xcframeworks whose name includes "Swift" for this and the next
32-
step.*
30+
> If the app does not use any Firebase Swift specific APIs, you do not need
31+
> to copy any xcframeworks whose name includes `Swift` for this and the next
32+
> step.
3333
3434
6. Drag each framework from the directory named after the SDK into the Project
3535
Navigator pane. Note that there may be no additional frameworks, in which
@@ -38,22 +38,25 @@ To integrate a Firebase SDK with your app:
3838
box that appears, make sure the target you want this framework to be added to
3939
has a checkmark next to it, and that you've selected "Copy items if needed."
4040

41-
*Do not add the Firebase frameworks to the "Embed Frameworks" Xcode build
42-
phase. The Firebase frameworks are not embedded dynamic frameworks, but are
43-
[static frameworks](https://www.raywenderlich.com/65964/create-a-framework-for-ios)
44-
which cannot be embedded into your application's bundle.*
41+
> Do not add the Firebase frameworks to the **Embed Frameworks** Xcode build
42+
> phase. The Firebase frameworks are not embedded dynamic frameworks, but are
43+
> [static frameworks](https://www.raywenderlich.com/65964/create-a-framework-for-ios)
44+
> which cannot be embedded into your application's bundle.
4545
4646
7. If the SDK has resources, go into the Resources folders, which will be in
4747
the SDK folder. Drag all of those resources into the Project Navigator, just
4848
like the frameworks, again making sure that the target you want to add these
4949
resources to has a checkmark next to it, and that you've selected "Copy items
5050
if needed".
51-
8. Add the -ObjC flag to "Other Linker Settings":
52-
a. In your project settings, open the Settings panel for your target
53-
b. Go to the Build Settings tab and find the "Other Linker Flags" setting
54-
in the Linking section.
55-
c. Double-click the setting, click the '+' button, and add "-ObjC" (without
56-
quotes)
51+
8. Add the `-ObjC` flag to **Other Linker Settings**:
52+
53+
a. In your project settings, open the **Settings** panel for your target.
54+
55+
b. Go to the Build Settings tab and find the **Other Linker Flags** setting
56+
in the **Linking** section.
57+
58+
c. Double-click the setting, click the '+' button, and add `-ObjC`
59+
5760
9. Drag the `Firebase.h` header in this directory into your project. This will
5861
allow you to `#import "Firebase.h"` and start using any Firebase SDK that you
5962
have.
@@ -64,6 +67,10 @@ To integrate a Firebase SDK with your app:
6467
a dummy Swift file to the app to prevent Swift system library missing
6568
symbol linker errors. See
6669
https://forums.swift.org/t/using-binary-swift-sdks-from-non-swift-apps/55989.
70+
71+
> ⚠ If prompted with the option to create a corresponding bridging header
72+
> for the new Swift file, select **Don't create**.
73+
6774
12. You're done! Compile your target and start using Firebase.
6875

6976
If you want to add another SDK, repeat the steps above with the xcframeworks for

0 commit comments

Comments
 (0)