From d95589d4e43d3a6288b8a66492c17d12c4e4eca0 Mon Sep 17 00:00:00 2001
From: Marc Cornellà <marc.cornella@live.com>
Date: Sat, 5 Sep 2015 23:17:38 +0200
Subject: Add README for the xcode plugin

---
 plugins/xcode/README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 plugins/xcode/README.md

(limited to 'plugins')

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.
-- 
cgit v1.2.3-70-g09d2