Clarifying unix-like support

Added `build.rs` to produce a compile error when attempting to build on a non-Unix-like system, and clarified support in `readme.md`. Signed-off-by: Jonathan Woollett-Light <[email protected]>
firecracker-microvm · Jun 13, 2022 · 863b037 · 863b037
1 parent a730d86
commit 863b037
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
 # micro-http
 
-This is a minimal implementation of the
+This is a minimal implementation of the 
 [HTTP/1.0](https://tools.ietf.org/html/rfc1945) and
 [HTTP/1.1](https://www.ietf.org/rfc/rfc2616.txt) protocols. This HTTP
 implementation is stateless thus it does not support chunking or compression.
 
 The micro-http implementation is used in production by Firecracker.
 
+As micro-http uses [`std::os::unix`](https://doc.rust-lang.org/std/os/unix/index.html) this crates only supports Unix-like targets.
+
 ## Contributing
 
 To contribute to micro-http, checkout the

diff --git a/build.rs b/build.rs
@@ -0,0 +1,4 @@
+fn main() {
+    #[cfg(not(target_family = "unix"))]
+    std::compile_error!("This crate only supports Unix-like targets");
+}