From 22d68c878f573d6a4e1c7b07b6c9e2fdb293ee49 Mon Sep 17 00:00:00 2001 From: iximeow Date: Sun, 12 Jan 2020 16:25:26 -0800 Subject: update readme, license, Cargo.toml --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6f8751a..f2202f9 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,30 @@ there are numerous architectures for which decoders are implemented, at varying | symbol | meaning | | ------ | ------- | -| + | complete, reliable | -| ? | "complete", likely has gaps | -| ~ | incomplete | -| - | unimplemented | +| 🥳 | complete, reliable | +| ⚠️| "complete", likely has gaps | +| 🚧 | incomplete | +| ❓ | unimplemented | | architecture | library | decode | tests | benchmarks | note | | ------------ | ------- | ------ | ----- | ---------- | ---- | -| `x86_64` | yaxpeax-x86 | ? | ~ | ~ | incomplete operand decoding, may incorrectly accept long instructions | -| `x86:32` | yaxpeax-x86 | - | - | - | should share most but not all implementation with `x86_64` | -| `x86:16` | yaxpeax-x86 | - | - | - | should share most but not all implementation with `x86:32` | -| `armv7` | yaxpeax-arm | ~ | ~ | - | | -| `armv8` | yaxpeax-arm | ~ | ~ | - | | -| `mips` | yaxpeax-mips | ~ | ~ | - | | -| `msp430` | yaxpeax-msp430 | ~ | ~ | - | | -| `pic17` | yaxpeax-pic17 | ~ | ~ | - | | -| `pic18` | yaxpeax-pic18 | ~ | ~ | - | | -| `pic24` | yaxpeax-pic24 | - | - | - | exists, but only decodes `NOP` | +| `x86_64` | yaxpeax-x86 | ⚠️| 🚧 | 🚧 | incomplete operand decoding, may incorrectly accept long instructions | +| `x86:32` | yaxpeax-x86 | ❓ | ❓ | ❓ | should share most but not all implementation with `x86_64` | +| `x86:16` | yaxpeax-x86 | ❓ | ❓ | ❓ | should share most but not all implementation with `x86:32` | +| `armv7` | yaxpeax-arm | 🚧 | 🚧 | ❓ | | +| `armv8` | yaxpeax-arm | 🚧 | 🚧 | ❓ | | +| `mips` | yaxpeax-mips | 🚧 | 🚧 | ❓ | | +| `msp430` | yaxpeax-msp430 | 🚧 | 🚧 | ❓ | | +| `pic17` | yaxpeax-pic17 | 🚧 | 🚧 | ❓ | | +| `pic18` | yaxpeax-pic18 | 🚧 | 🚧 | ❓ | | +| `pic24` | yaxpeax-pic24 | ❓ | ❓ | ❓ | exists, but only decodes `NOP` | + +### mirrors + +the canonical copy of `yaxpeax-arch` is at [https://git.iximeow.net/yaxpeax-arch](https://git.iximeow.net/yaxpeax-arch). + +`yaxpeax-arch` is also mirrored on GitHub at [https://www.github.com/iximeow/yaxpeax-x86](https://www.github.com/iximeow/yaxpeax-arch). + +### ! user beware ! +these interfaces will almost certainly move and change. the version number is `0.0.1` and i mean it with every fiber of my being. -- cgit v1.1