Browse Source

docs(term_tab): rewrite README in markdown (#11381)

Basil Sh 1 year ago
parent
commit
82c0db41bc
2 changed files with 16 additions and 16 deletions
  1. 0 16
      plugins/term_tab/README
  2. 16 0
      plugins/term_tab/README.md

+ 0 - 16
plugins/term_tab/README

@@ -1,16 +0,0 @@
-
-term_tab - 'cwd' for all open zsh sessions
-******************************************
-
-What it does:
-*************
-This plugin allows to complete the 'cwd' of other Zsh sessions. Sounds
-complicated but is rather simple. E.g. if you have three zsh sessions open, in
-each session you are in a different folder, you can hit Ctrl+v in one session
-to show you the current working directory of the other open zsh sessions.
-
-How it works:
-*************
-* It uses 'pidof zsh' to determine all zsh PIDs
-* It reads procfs to get the current working directory of this session
-* Everything is fed into zsh's completion magic

+ 16 - 0
plugins/term_tab/README.md

@@ -0,0 +1,16 @@
+# term_tab plugin
+
+term_tab - `cwd` for all open zsh sessions
+
+## What it does:
+
+This plugin allows to complete the `cwd` of other Zsh sessions. Sounds
+complicated but is rather simple. E.g. if you have three zsh sessions open, in
+each session you are in a different folder, you can hit `Ctrl+V` in one session
+to show you the current working directory of the other open zsh sessions.
+
+## How it works:
+
+* It uses `pidof zsh` to determine all zsh PIDs
+* It reads procfs to get the current working directory of this session
+* Everything is fed into zsh's completion magic