1Unicorn Engine
2==============
3
4[![Join the chat at https://gitter.im/unicorn-engine/chat](https://badges.gitter.im/unicorn-engine/unicorn.svg)](https://gitter.im/unicorn-engine/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5[![Build Status](https://travis-ci.org/unicorn-engine/unicorn.svg?branch=master)](https://travis-ci.org/unicorn-engine/unicorn)
6[![pypi downloads](https://pepy.tech/badge/unicorn)](https://pepy.tech/project/unicorn)
7[![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)
8
9Unicorn is a lightweight, multi-platform, multi-architecture CPU emulator framework
10based on [QEMU](http://qemu.org).
11
12Unicorn offers some unparalleled features:
13
14- Multi-architecture: ARM, ARM64 (ARMv8), M68K, MIPS, SPARC, and X86 (16, 32, 64-bit)
15- Clean/simple/lightweight/intuitive architecture-neutral API
16- 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.
17- Native support for Windows & *nix (with Mac OSX, Linux, *BSD & Solaris confirmed)
18- High performance via Just-In-Time compilation
19- Support for fine-grained instrumentation at various levels
20- Thread-safety by design
21- Distributed under free software license GPLv2
22
23Further information is available at http://www.unicorn-engine.org
24
25
26License
27-------
28
29This project is released under the [GPL license](COPYING).
30
31
32Compilation & Docs
33------------------
34
35See [docs/COMPILE.md](docs/COMPILE.md) file for how to compile and install Unicorn.
36
37More documentation is available in [docs/README.md](docs/README.md).
38
39
40Contact
41-------
42
43[Contact us](http://www.unicorn-engine.org/contact/) via mailing list, email or twitter for any questions.
44
45
46Contribute
47----------
48
49If you want to contribute, please pick up something from our [Github issues](https://github.com/unicorn-engine/unicorn/issues).
50
51We also maintain a list of more challenged problems in a [TODO list](https://github.com/unicorn-engine/unicorn/wiki/TODO).
52
53[CREDITS.TXT](CREDITS.TXT) records important contributors of our project.
54
55