summaryrefslogtreecommitdiff
path: root/plugins/sublime-merge/README.md
diff options
context:
space:
mode:
authorAmir Masoud Abdol <amirmasoudabdol@icloud.com>2020-10-03 11:47:18 +0200
committerGitHub <noreply@github.com>2020-10-03 11:47:18 +0200
commitd5dc9f71534e95547d73feff366a4437f6d7ef31 (patch)
treea62831fe44d8ca72cce2027068959fd91826bc2e /plugins/sublime-merge/README.md
parent1617f4ffafd6114fb3ccbdbb782eeaf25a7f2905 (diff)
downloadzsh-d5dc9f71534e95547d73feff366a4437f6d7ef31.tar.gz
zsh-d5dc9f71534e95547d73feff366a4437f6d7ef31.tar.bz2
zsh-d5dc9f71534e95547d73feff366a4437f6d7ef31.zip
Add sublime-merge plugin (#7228)
Diffstat (limited to 'plugins/sublime-merge/README.md')
-rw-r--r--plugins/sublime-merge/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/sublime-merge/README.md b/plugins/sublime-merge/README.md
new file mode 100644
index 000000000..534479179
--- /dev/null
+++ b/plugins/sublime-merge/README.md
@@ -0,0 +1,17 @@
+## sublime-merge
+
+Plugin for Sublime Merge, a cross platform text and code editor, available for Linux, Mac OS X, and Windows.
+
+### Requirements
+
+ * [Sublime Merge](https://www.sublimemerge.com)
+
+### Usage
+
+ * If `sm` command is called without an argument, launch Sublime Merge
+
+ * If `sm` is passed a directory, `cd` to it and open the existing git repository in Sublime Merge
+
+ * If `smt` command is called, it is equivalent to `sm .`, opening the existing git repository in the current folder in Sublime Merge
+
+ * If `ssm` command is called, it is like `sudo sm`, opening the git repository in Sublime Merge. Useful for editing system protected repositories. \ No newline at end of file