From ec5557452fbb7038dd4fdf7b5faa8405a184c503 Mon Sep 17 00:00:00 2001 From: iximeow Date: Sat, 23 Dec 2023 16:51:38 -0800 Subject: and readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..da50c9d --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +## yaxpeax-rx + +[![crate](https://img.shields.io/crates/v/yaxpeax-x86.svg?logo=rust)](https://crates.io/crates/yaxpeax-x86) +[![documentation](https://docs.rs/yaxpeax-x86/badge.svg)](https://docs.rs/yaxpeax-x86) + +renesas rx decoder implementedf as part of the yaxpeax project, implementing traits provided by `yaxpeax-arch`. + +### features + +* supports decoding under `v1`, `v2`, and `v3`-specific profiles +* should support `#[no_std]` +* exists (this is not the only RX disassembler by any means) + +### mirrors + +the canonical copy of `yaxpeax-rx` is at [https://git.iximeow.net/yaxpeax-rx/](https://git.iximeow.net/yaxpeax-rx/). + +`yaxpeax-rx` is also mirrored on GitHub at [https://www.github.com/iximeow/yaxpeax-rx](https://www.github.com/iximeow/yaxpeax-rx). + +### changelog +a changelog across crate versions is maintained in the `CHANGELOG` file located in the repo, as well as [online](https://git.iximeow.net/yaxpeax-rx/tree/CHANGELOG). -- cgit v1.1