From ccc25fd0f05ab07123998e6d8e70a4c8cd3e0021 Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Thu, 26 Sep 2019 05:46:06 +0530 Subject: [PATCH] Update docs --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5bdb405a..e5893433 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@

Latest release -Homebrew Arch Linux Debian Buster+ Fedora 27+ +Homebrew openSUSE Leap 15.0+ Ubuntu Artful+

@@ -31,6 +31,7 @@ - [Introduction](#introduction) - [Features](#features) +- [Quickstart](#quickstart) - [Installation](#installation) - [Library dependencies](#library-dependencies) - [Utility dependencies](#utility-dependencies) @@ -49,7 +50,7 @@ ## Introduction -`nnn` is a full-featured terminal file manager. It's extremely light and fast (**[performance](https://github.com/jarun/nnn/wiki/Performance)**). +`nnn` is a full-featured terminal file manager. It's tiny, extremely light and fast (**[performance](https://github.com/jarun/nnn/wiki/Performance)**). `nnn` is also a disk usage analyzer, a fuzzy app launcher, a batch file renamer and a file picker. 30+ **[plugins](https://github.com/jarun/nnn/tree/master/plugins)** extend the capabilities further. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim). Custom plugins are easy to add. @@ -103,6 +104,18 @@ Visit the **[Wiki](https://github.com/jarun/nnn/wiki)** for operational concepts - Minimal library dependencies - Widely available +## Quickstart + +While we strongly advise reading this page and the wiki, if you can't wait to start using `nnn`: + +1. Install the [utilities you may need](https://github.com/jarun/nnn#utility-dependencies) based on your regular workflows. +2. Configure [cd on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit). +3. Optionally open all text files in `$EDITOR` (fallback vi): `export NNN_USE_EDITOR=1` +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/misc/nlaunch). + +- Don't memorize keys. Arrows, / and q suffice. Press ? for help on keyboard shortcuts anytime. +- To set `nnn` as the default file manager, follow these [instructions](https://github.com/jarun/nnn/wiki/Advanced-use-cases#configure-as-default-fm). + ## Installation #### Library dependencies