diff options
Diffstat (limited to 'plugins/atom/README.md')
| -rw-r--r-- | plugins/atom/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/atom/README.md b/plugins/atom/README.md new file mode 100644 index 000000000..6350c647b --- /dev/null +++ b/plugins/atom/README.md @@ -0,0 +1,23 @@ +## atom + +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 + + * [Atom](https://atom.io/) + +### Usage + + * If `at` command is called without an argument, launch Atom + + * If `at` is passed a directory, open it in Atom + + * If `at` is passed a file, open it 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` |