Skip to content

Commit 765f7c9

Browse files
committed
README.md: add that workspace should be opened after CocoaPods is done
1 parent eae2855 commit 765f7c9

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ let oldClauses = query.find()
2222
Want details? **[Read the guides](https://swift.objectbox.io/)** or
2323
**[check out the API docs](https://objectbox.io/docfiles/swift/current/)**.
2424

25-
Installation
26-
------------
25+
Adding ObjectBox to your project
26+
--------------------------------
2727
[CocoaPods](https://cocoapods.org) is recommended to set up ObjectBox in your project.
2828
See the [installation docs](https://swift.objectbox.io/install) for alternative setups,
2929
or the [New to CocoaPods?](#new-to-cocoapods) section below for a quick intro.
@@ -41,20 +41,21 @@ pod install
4141
Pods/ObjectBox/setup.rb myproject.xcodeproj # whatever your Xcode project is named
4242
```
4343

44-
Now you are all set to define your first ObjectBox entities;
44+
And, don't forget to close the Xcode project (.xcodeproj) and open the workspace (.xcworkspace) instead.
45+
Now, you are all set to define your first ObjectBox entities;
4546
e.g. check the [getting started guide] or the [example](#example) described below.
4647

4748
### <a name="new-to-cocoapods"></a>New to CocoaPods?
4849

49-
[CocoaPods](https://cocoapods.org) is a dependency manager and sets up libraries like ObjectBox in your xcode project.
50+
[CocoaPods](https://cocoapods.org) is a dependency manager and sets up libraries like ObjectBox in your Xcode project.
5051
To install it, run this in a terminal:
5152

5253
```bash
5354
sudo gem install cocoapods
5455
```
5556

5657
In CocoaPods, you keep track of used libraries in a file called "Podfile".
57-
If you don't have this file yet, navigate to your xcode project folder and use CocoaPods to create one:
58+
If you don't have this file yet, navigate to your Xcode project folder and use CocoaPods to create one:
5859

5960
```bash
6061
pod init
@@ -104,9 +105,7 @@ For general news on ObjectBox, [check our blog](https://objectbox.io/blog).
104105
Background: code generation
105106
---------------------------
106107
ObjectBox Swift generates code at build time for optimal performance at runtime by avoiding reflection etc.
107-
108108
This is automatically done for you and should be transparent.
109-
110109
Internally, we use [a fork of Sourcery](https://github.com/objectbox/objectbox-swift-generator) for this.
111110

112111
Source code

0 commit comments

Comments
 (0)