mirrors
/
nnn
mirror of https://github.com/jarun/nnn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs

This commit is contained in:
Arun Prakash Jana 2019-12-03 06:10:32 +05:30
parent 5cd9794102
commit f80563e16a
No known key found for this signature in database
GPG Key ID: A75979F35C080412
2 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -59,7 +59,7 @@ Add to that an awesome [Wiki](https://github.com/jarun/nnn/wiki)!
- Run plugins and commands with custom keybinds
- FreeDesktop compliant trash (needs trash-cli)
- Cross-dir file/all/range selection
- Batch rename selection or dir entries
- Batch renamer (feature-limited) for selection or dir
- Copy (as), move (as), delete, archive, link selection
- Create (with parents), rename, duplicate (anywhere) files and dirs
- Spawn a shell, run apps, run commands, execute file

10
plugins/README.md
View File

@ -102,13 +102,9 @@ Plugins can also access the current selections by reading the `.selections` file
## Create your own plugins
Plugins are a powerful yet easy way to extend the capabilities of `nnn`.
Plugins are scripts that can be written in any scripting language. However, POSIX-compliant shell scripts runnable in `sh` are preferred.
Each script has a _Description_ section which provides more details on what the script does, if applicable.
The plugins reside in `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
Once it's ready, drop the plugin in `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins` and make it executable. Optionally add a custom keybind in `$NNN_PLUG` if you intend to use the plugin frequently.
#### Controlling `nnn`'s active directory
`nnn` provides a mechanism for plugins to control its active directory.
@ -156,6 +152,6 @@ There are many plugins provided by `nnn` which can be used as examples. Here are
## Contributing plugins
Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.
Add informative sections like _Description_, _Notes_, _Dependencies_, _Shell_, _Author_ etc. in the plugin as applicable. Add an entry in the table above. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.
The plugins should be executable. Please add an entry in the table above.
The plugins should be executable.