Unicorn Engine
==============

Unicorn is a lightweight, multi-platform, multi-architecture CPU emulator framework
based on [QEMU](http://qemu.org).

Unicorn offers some unparalleled features:

- Multi-architecture: ARM, ARM64 (ARMv8), M68K, MIPS, SPARC, and X86 (16, 32, 64-bit)
- Clean/simple/lightweight/intuitive architecture-neutral API
- Implemented in pure C language, with bindings for Python, Java, and Go
- Native support for Windows & *nix (with Mac OSX, Linux, *BSD & Solaris confirmed)
- High performance via Just-In-Time compilation
- Support for fine-grained instrumentation at various levels
- Thread-safety by design
- Distributed under free software license GPLv2

Further information is available at http://www.unicorn-engine.org


License
-------

This project is released under the [GPL license](COPYING).


Compilation & Docs
------------------

See [COMPILE.TXT](COMPILE.TXT) file for how to compile and install Unicorn.

More documentation is available in [docs/README](docs/README)


Contact
-------

Contact us via mailing list, email or twitter. More information is available
at http://www.unicorn-engine.org/contact/


Contribute
----------

If you want to contribute, please pick up something from our Github issues
at https://github.com/unicorn-engine/unicorn

We also maintain a TODO list at https://github.com/unicorn-engine/unicorn/wiki/TODO.

[CREDITS.TXT](CREDITS.TXT) lists important contributors of our project.