From f9bc3d2e269a87fad8d51b7dcb69655051b7080d Mon Sep 17 00:00:00 2001 From: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com> Date: Sun, 16 Feb 2025 12:04:52 +0100 Subject: [PATCH] Moved a bit of information from the base README to the docs README Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com> --- README.md | 25 +++++++------------------ docs/README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 18 deletions(-) create mode 100644 docs/README.md diff --git a/README.md b/README.md index 1fec742..9a7ecdc 100644 --- a/README.md +++ b/README.md @@ -29,17 +29,18 @@ It uses [fzf](https://github.com/junegunn/fzf), [skim](https://github.com/lotabo ## Installation -**navi** can be installed with the following package managers: - -[![Packaging status](https://repology.org/badge/vertical-allrepos/navi.svg)](https://repology.org/project/navi/versions) - The recommended way to install **navi** is by running: ```sh brew install navi ``` -If `brew` isn't available, you can check [alternative install instructions](docs/installation.md). +> [!NOTE] +> For more details on how to install Navi, see [docs/installation](docs/installation/README.md) + +**navi** can be installed with the following package managers: + +[![Packaging status](https://repology.org/badge/vertical-allrepos/navi.svg)](https://repology.org/project/navi/versions) ## Usage @@ -103,17 +104,5 @@ Please run the following command to read more about all possible options: navi --help ``` -In addition, please check the [/docs](docs) folder. +In addition, please check the [/docs](docs) folder or the website. -## Similar tools - -There are many similar projects out there ([beavr](https://github.com/denisidoro/beavr), [bro](https://github.com/hubsmoke/bro), [cheat](https://github.com/cheat/cheat), [cheat.sh](https://github.com/chubin/cheat.sh), [cmdmenu](https://github.com/amacfie/cmdmenu), [eg](https://github.com/srsudar/eg), [how2](https://github.com/santinic/how2), [howdoi](https://github.com/gleitz/howdoi), [Command Line Interface Pages](https://github.com/command-line-interface-pages) and [tldr](https://github.com/tldr-pages/tldr), to name a few). - -They are excellent projects, but **navi** remains unique in the following ways: - -- it's natural to write cheatsheets tailored to your needs -- arguments are neither hardcoded nor a simple template - -## Etymology - -[Navi](https://zelda.gamepedia.com/Navi) is a character from [The Legend of Zelda Ocarina of Time](https://zelda.gamepedia.com/Ocarina_of_Time) that provides [Link](https://zelda.gamepedia.com/Link) with a variety of clues to help him solve puzzles and make progress in his quest. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..2ddc246 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,41 @@ +# Navi icon [![Actions Status](https://github.com/denisidoro/navi/workflows/CI/badge.svg)](https://github.com/denisidoro/navi/actions) ![GitHub release](https://img.shields.io/github/v/release/denisidoro/navi?include_prereleases) + +## Table of Contents + + +* [Navi icon ![Actions Status](https://github.com/denisidoro/navi/workflows/CI/badge.svg) ![GitHub release](https://img.shields.io/github/v/release/denisidoro/navi?include_prereleases)](#navi-img-srchttpsrawgithubusercontentcomdenisidoronavimasterassetsiconpng-alticon-height28px--) + * [Table of Contents](#table-of-contents) + * [About](#about) + * [Navi Pros](#navi-pros) + * [Similar tools](#similar-tools) + * [Etymology](#etymology) + + +## About + +Navi is an interactive cheatsheet tool for the command-line.\ +It allows you to browse through cheatsheets (that you may write yourself or download from maintainers) and execute commands. + +[![Demo](https://asciinema.org/a/406461.svg)](https://asciinema.org/a/406461) + +It uses [fzf](https://github.com/junegunn/fzf), [skim](https://github.com/lotabout/skim), or [Alfred](https://www.alfredapp.com/) under the hood and it can be either used as a command or as a shell widget (_à la_ Ctrl-R). + +## Navi Pros + +- it will spare you from knowing CLIs by heart +- it will spare you from copy-pasting output from intermediate commands +- it will make you type less +- it will teach you new one-liners + +## Similar tools + +There are many similar projects out there ([beavr](https://github.com/denisidoro/beavr), [bro](https://github.com/hubsmoke/bro), [cheat](https://github.com/cheat/cheat), [cheat.sh](https://github.com/chubin/cheat.sh), [cmdmenu](https://github.com/amacfie/cmdmenu), [eg](https://github.com/srsudar/eg), [how2](https://github.com/santinic/how2), [howdoi](https://github.com/gleitz/howdoi), [Command Line Interface Pages](https://github.com/command-line-interface-pages) and [tldr](https://github.com/tldr-pages/tldr), to name a few). + +They are excellent projects, but **navi** remains unique in the following ways: + +- it's natural to write cheatsheets tailored to your needs +- arguments are neither hardcoded nor a simple template + +## Etymology + +[Navi](https://zelda.gamepedia.com/Navi) is a character from [The Legend of Zelda Ocarina of Time](https://zelda.gamepedia.com/Ocarina_of_Time) that provides [Link](https://zelda.gamepedia.com/Link) with a variety of clues to help him solve puzzles and make progress in his quest.