From 7417c6e4f382f847f841db84c6cb26bcb82716de Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Tue, 1 Oct 2024 08:12:06 +0300 Subject: [PATCH] docs: fix missing documentation link in README --- .github/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/README.md b/.github/README.md index 1c3e22c..531d062 100644 --- a/.github/README.md +++ b/.github/README.md @@ -124,10 +124,16 @@ The _recommended_ way of installing **nvf** is using either the NixOS or the Home-Manager module, though it is completely possible and no less supported to install **nvf** as a standalone package, or a flake output. -See the [**nvf** manual] for detailed and up-to-date installation guides, +See the rendered [nvf manual] for detailed and up-to-date installation guides, configurations, available options, release notes and more. Tips for installing userspace plugins is also contained in the documentation. +> [!TIP] +> While using NixOS or Home-Manager modules, +> `programs.nvf.enableManpages = true;` will allow you to view option +> documentation from the comfort of your terminal via `man 5 nvf`. The more you +> know. + Please create an issue on the [issue tracker] if you find the documentation lacking or confusing. Any improvements to the documentation through pull requests are also welcome, and appreciated.