summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2019-03-08 12:38:27 -0800
committerTavian Barnes <tavianator@tavianator.com>2019-03-08 12:46:35 -0800
commitafbd26dc1d08e5786987018154ee10a3a447ae9b (patch)
tree32c47ab4e984b9c6e2eb6a93fdbf41ae489fdb3e
parent9c76c4faa6474122d7d2e7dffdcacc1d84a4dbd8 (diff)
downloadbfs-afbd26dc1d08e5786987018154ee10a3a447ae9b.tar.xz
README: Reorganize it a bit
-rw-r--r--README.md42
1 files changed, 27 insertions, 15 deletions
diff --git a/README.md b/README.md
index f8af7c2..6e16e10 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
`bfs`
=====
+<img src="https://tavianator.github.io/bfs/screenshot.svg" alt="Screenshot" align="right" />
+
[![License](http://img.shields.io/badge/license-0BSD-blue.svg)](https://github.com/tavianator/bfs/blob/master/COPYING)
[![LOC](https://tokei.rs/b1/github/tavianator/bfs?category=code)](https://github.com/Aaronepower/tokei)
[![Build Status](https://api.travis-ci.org/tavianator/bfs.svg?branch=master)](https://travis-ci.org/tavianator/bfs)
@@ -96,18 +98,11 @@ Compare `bfs -nohidden` to
find -name '.?*' -prune -o -print
-Pretty
-------
-
-When `bfs` detects that its output is a terminal, it automatically colors its output with the same colors `ls` uses.
-This makes it easier to identify relevant files at a glance.
-
-<img src="https://tavianator.github.io/bfs/screenshot.svg" alt="Screenshot" width="100%" />
-
-
Try it!
-------
+<a href="https://repology.org/metapackage/bfs"><img src="https://repology.org/badge/vertical-allrepos/bfs.svg" alt="Packaging status" align="right" /></a>
+
To get `bfs`, download one of the [releases](https://github.com/tavianator/bfs/releases) or clone the [git repo](https://github.com/tavianator/bfs).
Then run
@@ -127,12 +122,29 @@ Finally, if you want to install it globally, run
$ sudo make install
-Alternatively, `bfs` may already be packaged for your distribution of choice:
+Alternatively, `bfs` may already be packaged for your distribution of choice.
+For example:
+
+### Alpine Linux
-[![Packaging status](https://repology.org/badge/vertical-allrepos/bfs.svg)](https://repology.org/metapackage/bfs)
+ # apk add bfs
-For example:
+### Debian/Ubuntu
+
+ # apt install bfs
+
+### NixOS
+
+ # nix-env -i bfs
+
+### Void Linux
+
+ # xbps-install -S bfs
+
+### MacPorts
+
+ # port install bfs
+
+### Homebrew
- # apt install bfs # Debian/Ubuntu
- $ sudo port install bfs # MacPorts
- $ brew install tavianator/tap/bfs # macOS Homebrew
+ $ brew install tavianator/tap/bfs