unicorn/README.md

57 lines
2.0 KiB
Markdown
Raw Normal View History

2015-09-21 05:08:49 +03:00
Unicorn Engine
==============
2020-05-12 11:51:59 +03:00
[![pypi downloads](https://pepy.tech/badge/unicorn)](https://pepy.tech/project/unicorn)
[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/unicorn.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:unicorn)
2016-03-01 08:54:32 +03:00
2021-10-03 17:17:51 +03:00
<p align="center">
<img width="250" src="docs/unicorn-logo.png">
</p>
Unicorn is a lightweight, multi-platform, multi-architecture CPU emulator framework, based on [QEMU](http://qemu.org).
2015-09-21 05:08:49 +03:00
Unicorn offers some unparalleled features:
2022-04-30 00:13:16 +03:00
- Multi-architecture: ARM, ARM64 (ARMv8), M68K, MIPS, PowerPC, RISCV, SPARC, S390X, TRICORE and X86 (16, 32, 64-bit)
2015-09-21 05:08:49 +03:00
- Clean/simple/lightweight/intuitive architecture-neutral API
- Implemented in pure C language, with bindings for Crystal, Clojure, Visual Basic, Perl, Rust, Ruby, Python, Java, .NET, Go, Delphi/Free Pascal, Haskell, Pharo, and Lua.
2021-10-05 23:49:18 +03:00
- Native support for Windows & *nix (with Mac OSX, Linux, Android, *BSD & Solaris confirmed)
2015-10-15 19:22:04 +03:00
- High performance via Just-In-Time compilation
2015-09-21 05:08:49 +03:00
- Support for fine-grained instrumentation at various levels
- Thread-safety by design
- Distributed under free software license GPLv2
2015-09-21 05:08:49 +03:00
Further information is available at http://www.unicorn-engine.org
2016-01-12 04:39:24 +03:00
License
-------
This project is released under the [GPL license](COPYING).
Compilation & Docs
------------------
2015-09-21 05:08:49 +03:00
See [docs/COMPILE.md](docs/COMPILE.md) file for how to compile and install Unicorn.
2015-09-21 05:08:49 +03:00
2016-01-12 04:43:40 +03:00
More documentation is available in [docs/README.md](docs/README.md).
2015-09-21 05:08:49 +03:00
2016-01-12 04:39:24 +03:00
Contact
2015-09-21 05:08:49 +03:00
-------
2016-01-12 04:50:17 +03:00
[Contact us](http://www.unicorn-engine.org/contact/) via mailing list, email or twitter for any questions.
2016-01-12 04:39:24 +03:00
Contribute
----------
2016-01-12 04:53:01 +03:00
If you want to contribute, please pick up something from our [Github issues](https://github.com/unicorn-engine/unicorn/issues).
2016-01-12 04:39:24 +03:00
2021-10-05 16:44:42 +03:00
We also maintain a list of more challenged problems in [milestones](https://github.com/unicorn-engine/unicorn/milestones) for our regular release.
2016-01-12 04:39:24 +03:00
2016-01-12 04:50:17 +03:00
[CREDITS.TXT](CREDITS.TXT) records important contributors of our project.
2016-01-12 04:39:24 +03:00