From 590b26bc3da2ad220933761cdaaa6a4be9682f87 Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Tue, 19 Apr 2022 14:27:09 -0400 Subject: README: Reformat to save some vertical space --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 50 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0ebac8f..a2ebeb6 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,37 @@ +
+ `bfs` ===== -[![License](http://img.shields.io/badge/license-0BSD-blue.svg)](https://github.com/tavianator/bfs/blob/main/LICENSE) -[![Version](https://img.shields.io/github/v/tag/tavianator/bfs?label=version)](https://github.com/tavianator/bfs/releases) -[![CI Status](https://github.com/tavianator/bfs/actions/workflows/ci.yml/badge.svg)](https://github.com/tavianator/bfs/actions/workflows/ci.yml) +Version +License +CI Status +Code coverage + +***Breadth-first search for your files.*** -Breadth-first search for your files. +[ **[Features](#features)** ]  +[ **[Installation](#installation)** ]  +[ **[Changelog](/docs/CHANGELOG.md)** ]  +[ **[Contributing](/docs/CONTRIBUTING.md)** ] -Screenshot +Screenshot +

+
-`bfs` is a variant of the UNIX `find` command that operates [breadth-first](https://en.wikipedia.org/wiki/Breadth-first_search) rather than [depth-first](https://en.wikipedia.org/wiki/Depth-first_search). +`bfs` is a variant of the UNIX `find` command that operates [**breadth-first**](https://en.wikipedia.org/wiki/Breadth-first_search) rather than [**depth-first**](https://en.wikipedia.org/wiki/Depth-first_search). It is otherwise compatible with many versions of `find`, including -- [POSIX `find`](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/find.html) -- [GNU `find`](https://www.gnu.org/software/findutils/) -- {[Free](https://www.freebsd.org/cgi/man.cgi?find(1)),[Open](https://man.openbsd.org/find.1),[Net](https://man.netbsd.org/find.1)}BSD `find` -- [macOS `find`](https://ss64.com/osx/find.html) +
+ +[ **[POSIX](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/find.html)** ]  +[ **[GNU](https://www.gnu.org/software/findutils/)** ]  +[ **[FreeBSD](https://www.freebsd.org/cgi/man.cgi?find(1))** ]  +[ **[OpenBSD](https://man.openbsd.org/find.1)** ]  +[ **[NetBSD](https://man.netbsd.org/find.1)** ]  +[ **[macOS](https://ss64.com/osx/find.html)** ] + +
If you're not familiar with `find`, the [GNU find manual](https://www.gnu.org/software/findutils/manual/html_mono/find.html) provides a good introduction. @@ -24,7 +40,10 @@ Features --------
-bfs operates breadth-first, which typically finds the file(s) you're looking for faster. + +bfs operates breadth-first, which typically finds the file(s) you're looking for faster. +

+ Imagine the following directory tree: @@ -72,7 +91,10 @@ haystack/deep/1/2/3/4
-bfs tries to be easier to use than find, while remaining compatible. + +bfs tries to be easier to use than find, while remaining compatible. +

+ For example, `bfs` is less picky about where you put its arguments: @@ -89,7 +111,10 @@ $ bfs -L haystack -name 'needle' │ $ find
-bfs gives helpful errors and warnings. + +bfs gives helpful errors and warnings. +

+ For example, `bfs` will detect and suggest corrections for typos: @@ -111,7 +136,10 @@ $ bfs -print -name 'needle'
-bfs adds some options that make common tasks easier. + +bfs adds some options that make common tasks easier. +

+ ### `-exclude` @@ -162,7 +190,10 @@ Installation ------------
-bfs may already be packaged for your operating system. + +bfs may already be packaged for your operating system. +

+ 
 Alpine Linux
@@ -189,7 +220,10 @@ $ brew install tavianator/tap/bfs
-To build bfs from source, you may need to install some dependencies. + +To build bfs from source, you may need to install some dependencies. +

+ The only absolute requirements for building `bfs` are a C compiler, [GNU make](https://www.gnu.org/software/make/), and [Bash](https://www.gnu.org/software/bash/). These are installed by default on many systems, and easy to install on most others. -- cgit v1.2.3