From dd3c95c61595ba28e88971ec6480145877e979ca Mon Sep 17 00:00:00 2001 From: Brian Mitchell Date: Wed, 10 Oct 2018 23:04:01 -0500 Subject: [PATCH 1/2] Add README for textmate plugin --- plugins/textmate/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 plugins/textmate/README.md diff --git a/plugins/textmate/README.md b/plugins/textmate/README.md new file mode 100644 index 000000000..8f86d35af --- /dev/null +++ b/plugins/textmate/README.md @@ -0,0 +1,16 @@ +# TextMate plugin + +The plugin adds aliases for the [TextMate](https://macromates.com) editor. + +To use it, add `textmate` to the plugins array of your zshrc file: +``` +plugins=(... textmate) +``` + +## Aliases + +| Alias | Command | Description | +|-----------------|-------------|---------------| +| tm | `mate .` | Open TextMate in the current directory. | +| tm \ | `mate ` `cd ` | Open TextMate in the given directory and cd to it. | +| tm <*> | `mate "$@"` | Pass all arguments to `mate`. This allows for easy opening of multiple files. | From 5df484d5054d282ba2aedff1785ad92eb7106bac Mon Sep 17 00:00:00 2001 From: Brian Mitchell Date: Fri, 12 Oct 2018 19:08:18 -0500 Subject: [PATCH 2/2] Format as a list vs a table --- plugins/textmate/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/plugins/textmate/README.md b/plugins/textmate/README.md index 8f86d35af..9fd342135 100644 --- a/plugins/textmate/README.md +++ b/plugins/textmate/README.md @@ -1,16 +1,16 @@ # TextMate plugin -The plugin adds aliases for the [TextMate](https://macromates.com) editor. +The plugin adds a function for the [TextMate](https://macromates.com) editor. To use it, add `textmate` to the plugins array of your zshrc file: ``` plugins=(... textmate) ``` -## Aliases +## Function -| Alias | Command | Description | -|-----------------|-------------|---------------| -| tm | `mate .` | Open TextMate in the current directory. | -| tm \ | `mate ` `cd ` | Open TextMate in the given directory and cd to it. | -| tm <*> | `mate "$@"` | Pass all arguments to `mate`. This allows for easy opening of multiple files. | +The `tm` function provides the following options: + +- No arguments: Run `mate` in the current directory. +- Argument that is a directory: Run `mate` in the given directory and cd to it. +- Other arguments: Pass all arguments to `mate`. This allows for easy opening of multiple files.