summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2022-03-11 11:39:05 -0500
committerTavian Barnes <tavianator@tavianator.com>2022-03-11 11:39:05 -0500
commit8bcf8303df96045167ebcb02b8fd4dc6e2b07526 (patch)
tree5faf9ee6332766520b486c98ebc79a30c6956651 /README.md
parentd0a0be33568e3f244bd8e6b8395cb7b90165d026 (diff)
downloadbfs-8bcf8303df96045167ebcb02b8fd4dc6e2b07526.tar.xz
README: Clarify some dependencies
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index a4d0355..c68dd97 100644
--- a/README.md
+++ b/README.md
@@ -169,7 +169,7 @@ $ brew install tavianator/tap/bfs
<details>
<summary>To build <code>bfs</code> from source, you may need to install some dependencies.</summary>
-The only absolute requirements for building `bfs` are a C compiler and GNU make.
+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.
Refer to your operating system's documentation on building software.
@@ -187,7 +187,7 @@ Here's how to install them on some common platforms:
<pre>
<strong>Alpine Linux</strong>
-# apk add acl-dev attr-dev libcap-dev oniguruma-dev
+# apk add acl{,-dev} attr{,-dev} libcap{,-dev} oniguruma-dev
<strong>Arch Linux</strong>
# pacman -S acl attr libcap oniguruma
@@ -202,7 +202,7 @@ Here's how to install them on some common platforms:
# nix-env -i acl attr libcap oniguruma
<strong>Void Linux</strong>
-# xbps-install -S acl-devel attr-devel libcap-devel oniguruma-devel
+# xbps-install -S acl-{devel,progs} attr-{devel,progs} libcap-{devel,progs} oniguruma-devel
<strong>FreeBSD</strong>
# pkg install oniguruma
@@ -221,9 +221,9 @@ Then run
$ make
This will build the `bfs` binary in the current directory.
-You can test it out:
+Run the test suite to make sure it works correctly:
- $ ./bfs -nohidden
+ $ make check
If you're interested in speed, you may want to build the release version instead: