Skip to content

Commit

Permalink
readme: we are all human
Browse files Browse the repository at this point in the history
  • Loading branch information
Will committed May 26, 2024
1 parent 1c7c522 commit 9c20987
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Enjoy!

A filesystem event watcher which is

1. User-Friendly
1. Friendly
> I try to keep the [1623](https://github.com/e-dant/watcher/blob/release/tool/sl)
lines that make up the runtime of *Watcher* [relatively simple](https://github.com/e-dant/watcher/blob/release/include/wtr/watcher.hpp)
and the API practical:
Expand Down Expand Up @@ -103,11 +103,12 @@ we use a near-zero amount of resources and makes
We regularly test that the overhead of detecting and sending an event to the user is
an order of magnitude less than the filesystem operations being measured.

4. Pretty Good Safety
4. Well Tested
> We run this project through
[unit tests against all available sanitiziers](https://github.com/e-dant/watcher/actions).
The code is safe (with reasonable certainty) and simple.
(This includes thread, memory, bounds, type and resource safety.)
At least for some definitions of safety, this project probably fits.

5. Dependency Minimal
> *Watcher* depends on the C++ Standard Library. For efficiency,
Expand All @@ -116,7 +117,7 @@ when possible on Linux, Darwin and Windows. For testing and
debugging, we use [Snitch](https://github.com/cschreib/snitch) and
[Sanitizers](https://clang.llvm.org/docs/index.html).

6. Runnable Mostly Anywhere
6. Portable
> *Watcher* is runnable almost anywhere. The only requirement
is a filesystem.

Expand Down

0 comments on commit 9c20987

Please sign in to comment.