aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRory Bradford <roryrjb@gmail.com>2022-11-19 11:22:53 +0000
committerRory Bradford <roryrjb@gmail.com>2022-11-19 11:25:45 +0000
commit87fe79f61fbea50d7670853b74d42f18d1c85cf6 (patch)
treee02d43ac473504f67fb74b3504ac216a2f6c705d
parent0f92f7352d1964a9859868439e8ded2c4de2111e (diff)
downloadrf-master.tar.gz
Update README to reflect win32 support and build instructionsHEADmaster
Signed-off-by: Rory Bradford <roryrjb@gmail.com>
-rw-r--r--README.md49
1 files changed, 23 insertions, 26 deletions
diff --git a/README.md b/README.md
index 69f763a..b745800 100644
--- a/README.md
+++ b/README.md
@@ -6,35 +6,33 @@
### Platform Support
-Ideally all the following platforms will eventually be supported:
-
-- [X] Linux glibc
-- [X] Linux musl
-- [X] macOS
-- [ ] Win32
-- [X] FreeBSD
-- [X] OpenBSD
-- [ ] NetBSD
-- [ ] DragonFlyBSD
-- [ ] illumos
-- [ ] Haiku
+Following platforms are supported:
+
+* Linux glibc/musl
+* macOS
+* Win32
+* FreeBSD
+* OpenBSD
### From Source
__Requirements:__
-Minimum requirements are a C99 compiler and a POSIX-like environment. The build
-system is `make`, any flavour _should_ be fine. For man pages you will require
-[__scdoc__(1)](https://sr.ht/~sircmpwn/scdoc/).
+Minimum requirements are a C99 compiler.
+
+__Building on POSIX:__
+
+```
+$ make
+```
-__Building:__
+__Building on Windows:__
-Unless you have custom requirements, just use `make`, the following options
-are available:
+Setup your environment with `vcvars64.bat`, then:
- $ make # -> dynamic binary
- $ make static # -> static binary
- # make install # -> install dynamic binary and man pages to PREFIX
+```
+> make
+```
## Usage
@@ -44,14 +42,13 @@ Let's start with a few simple examples.
If you want to find all `.c` files recursively from the current directory:
- $ rf \*.c
+ rf *.c
-This is essentially a shortened version of the traditional `find . -name \*.c`.
-Underneath rf uses [`fnmatch`](https://man.openbsd.org/fnmatch) so all the usual
+rf uses [`fnmatch`](https://man.openbsd.org/fnmatch)/[`PathMatchSpecA`](https://learn.microsoft.com/en-us/windows/win32/api/shlwapi/nf-shlwapi-pathmatchspeca) so all the usual
glob rules apply. You can also use substring matching instead, something like:
- $ rf -s hello
+ rf -s hello
-This would match any files with 'hello' any where in the name. Although this is
+This would match any files with 'hello' anywhere in the name. Although this is
less flexible, it can potentially make things easier and faster depending on
the particular use case.