From aa14a98ff9e5171540be07d7374cffe48e9ef1fa Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Thu, 23 May 2019 04:54:38 +0530 Subject: [PATCH] Update docs --- README.md | 34 +++++++++++++++------------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 08c16368..88c1433d 100644 --- a/README.md +++ b/README.md @@ -15,28 +15,25 @@ Travis Status CircleCI Status License +Donate via PayPal!

+`nnn` is a full-featured file manager for low-power, low-frequency, resource-limited devices and the regular desktop. It aims to be **[one of the fastest and most lightweight](https://github.com/jarun/nnn/wiki/performance)** file managers. + +`nnn` is also a disk usage analyzer, a fuzzy app launcher and a batch file renamer. + +It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows and Termux on Android. + +Several **[plugins](https://github.com/jarun/nnn/tree/master/plugins)** are available to extend its power. New plugins can be added easily. + +`nnn` works seamlessly with DEs and GUI utilities. **[Quickstart](#quickstart)** and see how `nnn` simplifies long desktop sessions. +

Click to watch video

3 modes of nnn (light with filter, detail, du analyzer) with memory usage. Click for a demo video.

-`nnn` is a full-featured file manager for low-power, low-frequency, resource-limited devices and the regular desktop. It aims to be **[one of the fastest and most lightweight](https://github.com/jarun/nnn/wiki/performance)** file managers. - -It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows and Termux on Android. - -`nnn` works seamlessly with DEs and GUI utilities. Several **[plugins](https://github.com/jarun/nnn/tree/master/plugins)** are available to extend its power. New plugins can be added easily. - -**[Quickstart](#quickstart)** and see how `nnn` simplifies long desktop sessions. - -*Love smart and efficient utilities? Explore [my repositories](https://github.com/jarun?tab=repositories). Buy me a cup of coffee if they help you.* - -

-Donate via PayPal! -

- #### TABLE OF CONTENTS - [Features](#features) @@ -136,9 +133,9 @@ The following table is a complete list. Some of the utilities may be installed b | --- | --- | | xdg-open (Linux), open(1) (macOS), cygstart (Cygwin) | desktop opener | | file, coreutils (cp, mv, rm), findutils (xargs) | detect type, copy, move and remove files | -| trash-cli | trash files (default: delete) | -| mediainfo / exiftool | multimedia file details | | atool / bsdtar / patool ([integration](https://github.com/jarun/nnn/wiki/hacking-nnn#integrate-patool)) | create, list and extract archives | +| mediainfo / exiftool | multimedia file details | +| trash-cli | trash files (default action: delete) | | sshfs, fusermount(3) | mount, unmount remote over SSHFS | | vlock (Linux), bashlock (macOS), lock(1) (BSD) | terminal locker | | advcpmv (Linux) ([integration](https://github.com/jarun/nnn/wiki/hacking-nnn#show-cp-mv-progress)) | copy, move progress | @@ -191,11 +188,10 @@ Option completion scripts for Bash, Fish and Zsh can be found in respective subd #### QUICKSTART -1. Install the [utilities required](#utility-dependencies) for your regular activities. +1. Install the [utilities you may need](#utility-dependencies) based on your regular workflows. 2. Configure [cd on quit](https://github.com/jarun/nnn/wiki/hacking-nnn#cd-on-quit). 3. Optionally open all text files in `$EDITOR` (fallback vi): `export NNN_USE_EDITOR=1` -4. Run `n`. -5. For additional functionality [install plugins](https://github.com/jarun/nnn/tree/master/plugins#installing-plugins) and the GUI app launcher [`nlaunch`](https://github.com/jarun/nnn/tree/master/scripts/nlaunch). +4. For additional functionality [install plugins](https://github.com/jarun/nnn/tree/master/plugins#installing-plugins) and the GUI app launcher [`nlaunch`](https://github.com/jarun/nnn/tree/master/scripts/nlaunch). - Don't memorize keys. Arrows, / and q suffice. Press ? for help on keyboard shortcuts anytime. - When you are ready for more, start [hacking `nnn`](https://github.com/jarun/nnn/wiki/hacking-nnn).