diff options
| author | Rory Bradford <roryrjb@gmail.com> | 2019-12-01 13:48:30 +0000 |
|---|---|---|
| committer | Rory Bradford <roryrjb@gmail.com> | 2019-12-01 13:48:30 +0000 |
| commit | fade373eed48d1725c6d1c889f079bb111bfcfa2 (patch) | |
| tree | fc8c38ad8302b9da0fb105949ea3d6d167480f1f | |
| parent | 62cde2ed8baf66de7ae074d17b6708886326ab7f (diff) | |
| download | rf-fade373eed48d1725c6d1c889f079bb111bfcfa2.tar.gz | |
Add basic README
Signed-off-by: Rory Bradford <roryrjb@gmail.com>
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ffdd2d2 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# rf + +> A tiny and simple cross-platform file finder + +### Installation + +The only requirements are a libc and a C compiler. `rf` has been successfully +tested on OpenBSD, FreeBSD and Linux (with glibc and musl), on x86, amd64 and arm +and with clang and gcc. + +``` +$ make install +``` + +### Usage + +See `man rf` for more details and examples. |