summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2015-09-05 23:17:38 +0200
committerMarc Cornellà <marc.cornella@live.com>2015-09-05 23:17:38 +0200
commitd95589d4e43d3a6288b8a66492c17d12c4e4eca0 (patch)
tree6b64376641a2a6c3dfda55f54d05e291cfb4e633 /plugins
parentec3694c788d2b32eb1735687cf89b057d4ca4d4d (diff)
downloadzsh-d95589d4e43d3a6288b8a66492c17d12c4e4eca0.tar.gz
zsh-d95589d4e43d3a6288b8a66492c17d12c4e4eca0.tar.bz2
zsh-d95589d4e43d3a6288b8a66492c17d12c4e4eca0.zip
Add README for the xcode plugin
Diffstat (limited to 'plugins')
-rw-r--r--plugins/xcode/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/plugins/xcode/README.md b/plugins/xcode/README.md
new file mode 100644
index 000000000..b8efef38c
--- /dev/null
+++ b/plugins/xcode/README.md
@@ -0,0 +1,31 @@
+# Xcode
+
+## Description
+
+This plugin provides a few utilities that can help you on your daily use of Xcode and iOS development.
+
+To start using it, add the `xcode` plugin to your `plugins` array:
+
+```zsh
+plugins=(... xcode)
+```
+
+
+## Aliases
+
+| Alias | Description | Command |
+|-------|---------------------------------------|------------------------------------------------|
+| xcsel | Change active developer directory | sudo xcode-select --switch |
+| xcp | Show currently active dev. directory | xcode-select --print-path |
+| xcb | Build Xcode projects and workspaces | xcodebuild |
+| xcdd | Purge all temporary build information | rm -rf ~/Library/Developer/Xcode/DerivedData/* |
+
+
+## Functions
+
+- **`xc`**:
+ Open one of the `.xcworkspace` and `.xcodeproj` files that it can find in the current working directory.
+ Returns 1 if it didn't find any relevant files.
+
+- **`simulator`**:
+ Open the iOS Simulator from your command line, dependant on whichever is the active developer directory for Xcode.