nnn

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

commit 971129736279cf62cd7473af99fcbd354385821b
parent 35fc77027ae4f4f0775994f39c2b528f252fca2b
Author: Arun Prakash Jana <engineerarun@gmail.com>
Date:   Mon,  3 Jun 2019 10:27:01 +0530

Update docs

Diffstat:
MREADME.md | 4----
Mplugins/README.md | 4++++
2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md @@ -418,10 +418,6 @@ To lookup keyboard shortcuts at runtime, press <kbd>?</kbd>. To extend the capabilities of `nnn`, [plugins](https://github.com/jarun/nnn/tree/master/plugins) are introduced. Plugins are scripts which `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins. -Use the pick plugin shortcut to visit the plugin directory and execute a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory. - -If you have an interesting plugin feel free to raise a PR. - #### TROUBLESHOOTING ##### Tmux configuration diff --git a/plugins/README.md b/plugins/README.md @@ -36,6 +36,10 @@ Plugins can access: Each script has a _Description_ section which provides more details on what the script does, if applicable. +#### Usage + +Use the _pick plugin_ shortcut to visit the plugin directory and execute a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory. + #### Contributing plugins Plugins are scripts and all scripting languages should work. However, POSIX-compliant shell scripts runnable in `sh` are preferred. If that's too rudimentary for your use case, use Python, Perl or Ruby. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.