mirror/rabbitizer
1
0
Fork 0
mirror of https://github.com/Decompollaborate/rabbitizer.git synced 2025-01-30 15:32:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

rust stuff on readme

Browse Source
This commit is contained in:
Angie 2022-12-18 18:37:07 -03:00
parent bddd12847e
commit 59f143b21d
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -4,6 +4,7 @@
![GitHub](https://img.shields.io/github/license/Decompollaborate/rabbitizer)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Decompollaborate/rabbitizer)
![PyPI](https://img.shields.io/pypi/v/rabbitizer)
![crate.io](https://img.shields.io/crates/dv/rabbitizer)
![GitHub contributors](https://img.shields.io/github/contributors/Decompollaborate/rabbitizer?logo=purple)
A MIPS instruction decoder API.
@ -12,6 +13,8 @@ Currently supports all the CPU instructions for MIPS I, II, III and IV.
## Installing
### Python bindings
The recommended way to install is using from the PyPi release, via `pip`:
```bash
@ -26,6 +29,19 @@ pip install git+https://github.com/Decompollaborate/rabbitizer.git@develop
NOTE: Installing the development version is not recommended. Proceed at your own risk.
See this package at <https://pypi.org/project/rabbitizer/>.
### Rust bindings
Add this crate to your `Cargo.toml` via:
```toml
[build]
rabbitizer = "*"
```
See this crate at <https://crates.io/crates/rabbitizer>.
## Features
- Should produces matching assembly.