aboutsummaryrefslogtreecommitdiffhomepage
path: root/detours-sys/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'detours-sys/README.md')
-rw-r--r--detours-sys/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/detours-sys/README.md b/detours-sys/README.md
new file mode 100644
index 0000000..ba5d2bc
--- /dev/null
+++ b/detours-sys/README.md
@@ -0,0 +1,34 @@
+# Detours-sys
+
+[![Crates.io](https://img.shields.io/crates/v/detours-sys.svg)](https://crates.io/crates/detours-sys)
+![maintenance-as-is](https://img.shields.io/badge/maintenance-as--is-yellow.svg)
+
+Rust bindings to [Microsoft Detours](https://github.com/Microsoft/Detours)
+
+## Usage
+
+See the [Detours Documentation](https://github.com/Microsoft/Detours/wiki) for details.
+
+## Details
+
+Use the `buildtime_generation` feature to generate bindings at build time,
+otherwise use pregenerated bindings.
+
+Note that this will require a relatively recent version of Clang be installed.
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0
+ ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
+* MIT license
+ ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
+
+at your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.