Rust-bindings for the ReOxide decompiler plugin framework
===========================
ReOxide adds a plugin system to the Ghidra decompiler, with the
larger goal of eventually improving the reverse engineering process
of Rust programs in open source tools. While anyone can extend the
Ghidra front end through its Java and Python API, the decompiler runs
as a separate C++ program. You cannot change the decompiler rules
through the Java API, but you can with ReOxide. You can define your
own decompiler actions or rules and better understand the inner
workings of the decompiler.
## Documentation
The [ReOxide homepage](https://reoxide.eu) offers a starting point
for the general documentation of the project:
* [Get started](https://reoxide.eu/guide/getting-started) by
installing the `reoxide` pip package and linking it with a
Ghidra installation.
* Follow the documentation on [how to load plugins](https://reoxide.eu/plugins/loading-plugins)
and [how to create plugins](https://reoxide.eu/plugins/creating-plugins)
yourself.
* For documentation related to the Rust API check out the
[docs.rs page of the ReOxide crate](https://docs.rs/reoxide).
## Acknowledgements
Special thanks to [rust-sfml](https://github.com/jeremyletang/rust-sfml)
and the [foreign-types library](https://github.com/sfackler/foreign-types)
for showing how to do certain FFI related things.