Compile and test the README.md.

emgre · Jan 4, 2020 · f9df604 · f9df604
1 parent 7042875
commit f9df604
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -17,6 +17,10 @@ maintenance = { status = "experimental" }
 [dependencies]
 winapi = { version = "0.3", features = ["bcrypt", "ntstatus"] }
 zeroize = { version = "1.1", optional = true }
+doc-comment = "0.3"
+
+[dev-dependencies]
+doc-comment = "0.3"
 
 [features]
 default = ["zeroize"]

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,4 @@
+use doc_comment::doctest;
 use winapi::shared::ntdef::NTSTATUS;
 use winapi::shared::ntstatus;
 
@@ -7,6 +8,9 @@ pub mod symmetric;
 
 mod helpers;
 
+// Compile and test the README
+doctest!("../README.md");
+
 /// Error type
 ///
 /// These errors are a subset of [`NTSTATUS`](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/596a1078-e883-4972-9bbc-49e60bebca55).