This repository has been archived by the owner on Nov 3, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 284
Polish README and fix installation instructions #419
Open
bih
wants to merge
3
commits into
CocoaPods:master
Choose a base branch
from
bih:bil/fix-readme
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+39
−22
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,35 +22,48 @@ If you want to hack on `CocoaPods.app`: | |
|
||
This is known to work on Xcode 9.3, and high sierra | ||
|
||
``` sh | ||
git clone https://github.com/CocoaPods/CocoaPods-app.git --recursive | ||
cd CocoaPods-app | ||
rake app:prerequisites --quiet | ||
open app/CocoaPods.xcworkspace | ||
```sh | ||
$ git clone https://github.com/CocoaPods/CocoaPods-app.git --recursive | ||
$ cd CocoaPods-app | ||
$ gem install rest | ||
$ rake app:prerequisites --quiet | ||
$ open app/CocoaPods.xcworkspace | ||
``` | ||
|
||
> Having an issue with running `rake app:rerequisities --quiet`? You might need to fork the CocoaPods/Specs repository locally to your computer. To do this simply run the following command: | ||
> | ||
> ```sh | ||
> $ git clone [email protected]:CocoaPods/Specs.git ~/.cocoapods/repos/master --depth=1 | ||
> ``` | ||
|
||
> Having an issue with `ruby/config.h` not found on OS X Mojave/Catalina? You need to install the SDK Headers by running the following: | ||
> | ||
> ```sh | ||
> $ open /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg | ||
> ``` | ||
|
||
This will set up your environment with a compiled versions of: ruby, git, cocoapods (the gem), hg, openssl, etc into both `destroot` and `workbench`. | ||
|
||
### Rake Tasks | ||
|
||
The main tasks can be found with `rake -T`: | ||
|
||
``` | ||
rake app:build # Build release version of application | ||
rake app:clean # Clean | ||
rake app:prerequisites # Prepare all prerequisites for building the app | ||
rake app:update_version # Updates the Info.plist of the application to reflect the CocoaPods version | ||
rake bundle:build # Build complete dist bundle | ||
rake bundle:clean:all # Clean all artefacts, including downloads | ||
rake bundle:clean:artefacts # Clean build and destroot artefacts | ||
rake bundle:submodules # Ensure Submodules are downloaded | ||
rake bundle:test # Test bundle | ||
rake bundle:verify_linkage # Verifies that no binaries in the bundle link to incorrect dylibs | ||
rake release # Create a clean release build for distribution | ||
rake release:build # Perform a full build of the bundle and app | ||
rake release:cleanbuild # Create a clean build | ||
rake release:sparkle # Version bump the Sparkle XML | ||
rake release:upload # Upload release | ||
```sh | ||
$ rake app:build # Build release version of application | ||
$ rake app:clean # Clean | ||
$ rake app:prerequisites # Prepare all prerequisites for building the app | ||
$ rake app:update_version # Updates the Info.plist of the application to reflect the CocoaPods version | ||
$ rake bundle:build # Build complete dist bundle | ||
$ rake bundle:clean:all # Clean all artefacts, including downloads | ||
$ rake bundle:clean:artefacts # Clean build and destroot artefacts | ||
$ rake bundle:submodules # Ensure Submodules are downloaded | ||
$ rake bundle:test # Test bundle | ||
$ rake bundle:verify_linkage # Verifies that no binaries in the bundle link to incorrect dylibs | ||
$ rake release # Create a clean release build for distribution | ||
$ rake release:build # Perform a full build of the bundle and app | ||
$ rake release:cleanbuild # Create a clean build | ||
$ rake release:sparkle # Version bump the Sparkle XML | ||
$ rake release:upload # Upload release | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adding the |
||
``` | ||
|
||
If you’re working on the build system and want to debug intermediate steps, such as building Ruby, | ||
|
@@ -60,4 +73,8 @@ We have heard reports of issues with installing on custom ruby installations, we | |
|
||
### Creating a release | ||
|
||
1. Run `rake release`. | ||
Run the following | ||
|
||
```sh | ||
$ rake release | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please don't encourage people to make shallow clones of the specs repo