summaryrefslogtreecommitdiff
path: root/rust/examples/dwarfdump/readme.md
diff options
context:
space:
mode:
authorKyleMiles <krm504@nyu.edu>2021-01-21 18:35:20 +0000
committerKyleMiles <krm504@nyu.edu>2021-01-21 19:07:07 +0000
commit2fcacc55d5466a7d17bdc0b3ce988772aa6d0653 (patch)
tree9d0f2ba19117843575936f2b93e0b6a578a84dc8 /rust/examples/dwarfdump/readme.md
parenta0da07c5c2860a5bd69921d38e438bbc1d43912f (diff)
cargo fmt and all my changes
Diffstat (limited to 'rust/examples/dwarfdump/readme.md')
-rw-r--r--rust/examples/dwarfdump/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/rust/examples/dwarfdump/readme.md b/rust/examples/dwarfdump/readme.md
new file mode 100644
index 00000000..ae3a193b
--- /dev/null
+++ b/rust/examples/dwarfdump/readme.md
@@ -0,0 +1,17 @@
+# DWARF Dump Example
+
+This is actually a fully-developed plugin, rather than a measly example.
+
+Two features this does not support are: files in big endian, and .dwo files
+
+## How to use
+
+Simply `cargo build --release` in this directory, and copy the `.so` from the target directory to your plugin directory
+
+### Attribution
+
+This example makes use of:
+ - [gimli] ([gimli license] - MIT)
+
+[gimli license]: https://github.com/gimli-rs/gimli/blob/master/LICENSE-MIT
+[gimli]: https://github.com/gimli-rs/gimli