diff options
| author | Ben Klein <robobenklein@gmail.com> | 2015-09-10 22:22:00 -0400 |
|---|---|---|
| committer | Ben Klein <robobenklein@gmail.com> | 2015-09-10 22:22:00 -0400 |
| commit | dca429557aef7b700ae2f1088115a707af78a31b (patch) | |
| tree | c86b02f325ba84bf8fce3005fb90f69764780dfd /plugins/atom/README.md | |
| parent | 953e4d892631f93e31cfdfb72199fb8f413c6b49 (diff) | |
| download | zsh-dca429557aef7b700ae2f1088115a707af78a31b.tar.gz zsh-dca429557aef7b700ae2f1088115a707af78a31b.tar.bz2 zsh-dca429557aef7b700ae2f1088115a707af78a31b.zip | |
Make Readme much clearer and explain edits.
Also added some examples, but those should be mostly self-explanatory.
Diffstat (limited to 'plugins/atom/README.md')
| -rw-r--r-- | plugins/atom/README.md | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/plugins/atom/README.md b/plugins/atom/README.md index 75d77a0ac..6350c647b 100644 --- a/plugins/atom/README.md +++ b/plugins/atom/README.md @@ -1,6 +1,8 @@ ## atom -Plugin for Atom, a cross platform text and code editor, available for Linux, Mac OS X, and Windows. +This plugin makes "at" a useful function for invoking the Atom Editor. + +Originally by Github user [aforty](https://github.com/aforty) for OSX, modified to alias 'at' to 'atom' for Linux, since atom already works on the terminal for Linux, and calling 'at' in a non-OSX environment should still work. ### Requirements @@ -10,8 +12,12 @@ Plugin for Atom, a cross platform text and code editor, available for Linux, Mac * If `at` command is called without an argument, launch Atom - * If `at` is passed a directory, `cd` to it and open it in Atom + * If `at` is passed a directory, open it in Atom * If `at` is passed a file, open it in Atom - * if `att` command is called, it is equivalent to `at .`, opening the current folder in Atom +### Examples + + * Open the current dir in atom: `at .` + * Open another dir in atom: `at path/to/folder` + * Open a file: `at filename.extension` |