d95589d4e43d3a6288b8a66492c17d12c4e4eca0

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

Add README for the xcode plugin

Diff

 1diff --git a/plugins/xcode/README.md b/plugins/xcode/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..b8efef38ca163d1785cac73562aae8ab13074d28
 4--- /dev/null
 5+++ b/plugins/xcode/README.md
 6@@ -0,0 +1,31 @@
 7+# Xcode
 8+
 9+## Description
10+
11+This plugin provides a few utilities that can help you on your daily use of Xcode and iOS development.
12+
13+To start using it, add the `xcode` plugin to your `plugins` array:
14+
15+```zsh
16+plugins=(... xcode)
17+```
18+
19+
20+## Aliases
21+
22+| Alias | Description                           | Command                                        |
23+|-------|---------------------------------------|------------------------------------------------|
24+| xcsel | Change active developer directory     | sudo xcode-select --switch                     |
25+| xcp   | Show currently active dev. directory  | xcode-select --print-path                      |
26+| xcb   | Build Xcode projects and workspaces   | xcodebuild                                     |
27+| xcdd  | Purge all temporary build information | rm -rf ~/Library/Developer/Xcode/DerivedData/* |
28+
29+
30+## Functions
31+
32+- **`xc`**:
33+  Open one of the `.xcworkspace` and `.xcodeproj` files that it can find in the current working directory.
34+  Returns 1 if it didn't find any relevant files.
35+
36+- **`simulator`**:
37+  Open the iOS Simulator from your command line, dependant on whichever is the active developer directory for Xcode.