Init.

README.md

@@ -0,0 +1,24 @@
+# Filesystem recorder
+
+Utility to record and replay file system events to produce test scenario on
+file-watching applications.
+
+## Build
+
+### Requirements
+
+This project use case is recording on linux and playing on windows. As such, the
+recorder is playing
+
+In order to make `fsr-play` available on windows, `fsr-rec` is split into a
+default feature that may be disabled during windows compilation.
+
+To build all possible artefacts for both linux and windows :
+
+```
+./build
+```
+
+> **note** Building for windows on linux requires the cargo-xwin program. It may
+> be installed through your package manager or through cargo
+> `cargo install cargo-xwin`