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

Compare commits

base: neurocyte:0f048dc47d686d1fe165945a0f898b5d56519a5d
Branches Tags
neurocyte:master
neurocyte:zig-0.15
..
compare: neurocyte:a2523a5b53a1fcd25e9a554afbc8b1f34e2b96ab
Branches Tags
neurocyte:master
neurocyte:zig-0.15

2 commits
0f048dc47d ... a2523a5b53

Author SHA1 Message Date
CJ van den Berg
a2523a5b53
docs: add some more platform support details to the readme 2026-03-08 20:11:18 +01:00
CJ van den Berg
a951162c52
docs: reformat README.md 2026-03-08 20:10:56 +01:00
1 changed files with 31 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -9,6 +9,7 @@
|___/ |___/
T H E N I G H T W A T C H T H E N I G H T W A T C H
``` ```
![nightwatch](docs/nightwatch.png) ![nightwatch](docs/nightwatch.png)
> The city sleeps. > The city sleeps.
@ -29,17 +30,26 @@ It does not interfere.
It does not speculate. It does not speculate.
It simply keeps watch. 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
@ -65,7 +75,7 @@ The executable will be located in:
zig build install zig build install
``` ```
------------------------------------------------------------------------ ---
# Using as a Zig Module # Using as a Zig Module
@ -91,7 +101,7 @@ const nightwatch = @import("nightwatch");
You now have programmatic access to the tracking engine. You now have programmatic access to the tracking engine.
------------------------------------------------------------------------ ---
# CLI Usage # CLI Usage
@ -107,7 +117,7 @@ nightwatch --help
for full command documentation. for full command documentation.
------------------------------------------------------------------------ ---
# Philosophy # Philosophy