Skip to content

Commit

Permalink
Remove Rainforest from dev instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
paulb777 committed Dec 29, 2020
1 parent 3251292 commit 3d95b5c
Showing 1 changed file with 4 additions and 26 deletions.
30 changes: 4 additions & 26 deletions source/contributing/dev-environment.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 4,7 @@ description: If you're looking to contribute to the CocoaPods project through fe
order: 3
---

CocoaPods is a collection of ruby gems. It is possible to clone them individually and set up a bundler environment for working in CocoaPods. However, for someone new to high-level library development in ruby this comes with a high learning curve. Because of this we will be using this guide to show how to set up using the [CocoaPods Rainforest](https://github.com/CocoaPods/Rainforest).

Rainforest is a git repo that when bootstrapped has submodules of all the required gems for CocoaPods development. Let's clone it:

```shell
$ git clone https://github.com/CocoaPods/Rainforest.git
$ cd Rainforest
```
All of the commands in Rainforest are Rake Tasks. This is a ruby variant of Make Tasks. You can take a look at all the available tasks by running `rake -T` in the terminal.

To get started downloading run:

```shell
$ rake bootstrap
```

This will loop through all the known gems downloading them, and setting up their environments. To verify that everything is set up, run: `CocoaPods/bin/pod --help`.
CocoaPods is a collection of ruby gems. It is possible to clone them individually and set up a bundler environment for working in CocoaPods. However, for someone new to high-level library development in ruby this comes with a high learning curve.

### Working on CocoaPods

Expand All @@ -33,12 17,6 @@ $ rake spec
$ rake examples:build
```

> Start kicker, which will run the specs relevant to the files you update.
```shell
$ kicker -c
```

Create your patch, verify all specs still pass and examples still build, and create a [pull request](https://github.com/CocoaPods/CocoaPods/compare).

### Using latest pod command
Expand All @@ -48,19 26,19 @@ If you would like to run latest pod command in terminal for you project.
> You could run it with full path, i.e.
```shell
path/to/Rainforest/CocoaPods/bin/pod install
path/to/CocoaPods/CocoaPods/bin/pod install
```

> For convenience you could add the next alias to you .zshrc or .bashrc or similar:
```shell
alias pod-dev='path/to/Rainforest/CocoaPods/bin/pod'
alias pod-dev='path/to/CocoaPods/CocoaPods/bin/pod'
```

Other advanced aliases:

> If you want to autoload [Pry](https://github.com/pry/pry) and the [Awesome Print](https://github.com/michaeldv/awesome_print) gems set the ```COCOA_PODS_ENV``` environment variable to ```development```. This can be done with an alias like:
```shell
alias pod-dev='COCOA_PODS_ENV=development path/to/Rainforest/CocoaPods/bin/pod'
alias pod-dev='COCOA_PODS_ENV=development path/to/CocoaPods/CocoaPods/bin/pod'
```

0 comments on commit 3d95b5c

Please sign in to comment.