From f38692e96864a155a44c8a7dd9d223032066d558 Mon Sep 17 00:00:00 2001
From: Arun Prakash Jana <engineerarun@gmail.com>
Date: Sun, 17 Mar 2019 21:59:36 +0530
Subject: [PATCH] Add readme on nlay

---
 scripts/nlay/README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 scripts/nlay/README.md

diff --git a/scripts/nlay/README.md b/scripts/nlay/README.md
new file mode 100644
index 00000000..4671eeca
--- /dev/null
+++ b/scripts/nlay/README.md
@@ -0,0 +1,31 @@
+## nlay
+
+`nlay` (*NnnpLAY*) is a customizable media type or action handler
+
+### Usage
+
+`nlay` is not used by `nnn` now. However, the bash script can be used to run desktop search utility or screensaver:
+
+    nlay file type
+    file: absolute path to file ("" for an action)
+    type: type of media or action
+
+### Default apps
+
+* gnome-search-tool, catfish - file search
+* vlock - terminal screensaver (alternatives - cmatrix, termsaver)
+
+### Perks
+
+- simple to modify (extensive in-file notes, comments and indicative code)
+- handle files by category (e.g. plaintext, search, screensaver)
+- support for multiple apps by order of preference
+- run app in the foreground or silently detached in the background
+- optionally add app arguments
+
+### Tips to modify
+
+- set `app=` in any category to change the player
+- set `opts=` to use app options
+- toggle `bg=` to enable or disable running app silently (`stdout` and `stderr` redirected to `/dev/null`) in background. E.g., vim (CLI) should be verbose and in the foreground while Sublime Text (GUI) can be started silently in the background.
+- enable the commented out code under `ENABLE_FILE_TYPE_HANDLING` to handle specific file extensions e.g. use a different app than the one used for the category.