about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
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.