neurocyte/nightwatch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add some more platform support details to the readme

Browse source
This commit is contained in:
CJ van den Berg 2026-03-08 20:11:18 +01:00
parent a951162c52
commit a2523a5b53
Signed by: neurocyte
GPG key ID: 8EB1E1BB660E3FB9
1 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -35,12 +35,21 @@ It simply keeps watch.
## Features ## Features
- Recursive directory tree tracking - Recursive directory tree tracking
- Deterministic multi-platform support (Linux, FreeBSD, MacOS, Windows) - Deterministic multi-platform support (Linux, macOS, FreeBSD, OpenBSD, NetBSD, DragonFly BSD, Windows)
- Lightweight and fast - Lightweight and fast
- Embeddable Zig module API - Embeddable Zig module API
- Standalone CLI executable - Standalone CLI executable
------------------------------------------------------------------------ ### Platform backends
| Platform | Backend | Notes |
| --------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------ |
| Linux | inotify | Threaded mode (default) or poll mode (`-Dlinux_read_thread=false`) |
| macOS | kqueue (default) or FSEvents (`-Dmacos_fsevents=true`) | FSEvents requires Xcode frameworks |
| FreeBSD, OpenBSD, NetBSD, DragonFly BSD | kqueue | |
| Windows | ReadDirectoryChangesW | |
---
# Installation # Installation