Skip to content

Add a section about linking process automation using rnpm #4797

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

Merged
skevy merged 2 commits into from
Dec 15, 2015
Merged

Add a section about linking process automation using rnpm #4797

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7927f1e
Add a section about linking process automation using rnpm
Dec 15, 2015
79799af
Reword section description
Dec 15, 2015
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
40 changes: 37 additions & 3 deletions docs/LinkingLibraries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,41 @@ error as soon as you try to use the library._

## Here the few steps to link your libraries that contain native code

### Step 1
### Automatic linking

"[rnpm](http://github.com/rnpm/rnpm)" is a community project that allows linking of native dependencies automatically:

#### Step 1

Install `rnpm`:
```bash
$ npm install rnpm -g
```

**Note:** _`rnpm` requires `node` version 4.1 or higher_

#### Step 2

Install a library with native dependencies:
```bash
$ npm install library-with-native-dependencies --save
```

**Note:** _`--save` or `--save-dev` flag is very important for this step. `rnpm` will link
your libs based on `dependencies` and `devDependencies` in your `package.json` file._

#### Step 3

Link your native dependencies:
```bash
$ rnpm link
```

Done! All libraries with a native dependencies should be successfully linked to your iOS/Android project.

### Manual linking

#### Step 1

If the library has native code, there must be a `.xcodeproj` file inside it's
folder.
Expand All @@ -33,15 +67,15 @@ on Xcode);

![](/react-native/img/AddToLibraries.png)

### Step 2
#### Step 2

Click on your main project file (the one that represents the `.xcodeproj`)
select `Build Phases` and drag the static library from the `Products` folder
inside the Library you are importing to `Link Binary With Libraries`

![](/react-native/img/AddToBuildPhases.png)

### Step 3
#### Step 3

Not every library will need this step, what you need to consider is:

Expand Down