unicorn/README.md

52 lines
1.4 KiB
Markdown
Raw Normal View History

2015-09-21 02:08:49 +00:00
Unicorn Engine
==============
Unicorn is a lightweight, multi-platform, multi-architecture CPU emulator framework
based on [QEMU](http://qemu.org).
Unicorn offers some unparalleled features:
2015-10-17 08:21:50 +00:00
- Multi-architecture: ARM, ARM64 (ARMv8), M68K, MIPS, SPARC, and X86 (16, 32, 64-bit)
2015-09-21 02:08:49 +00:00
- 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)
2015-10-15 16:22:04 +00:00
- High performance via Just-In-Time compilation
2015-09-21 02:08:49 +00:00
- Support for fine-grained instrumentation at various levels
- Thread-safety by design
- Distributed under free software license GPLv2
2015-09-21 02:08:49 +00:00
Further information is available at http://www.unicorn-engine.org
2016-01-12 01:39:24 +00:00
License
-------
This project is released under the [GPL license](COPYING).
Compilation & Docs
------------------
2015-09-21 02:08:49 +00:00
See [COMPILE.TXT](COMPILE.TXT) file for how to compile and install Unicorn.
2016-01-12 01:43:40 +00:00
More documentation is available in [docs/README.md](docs/README.md).
2015-09-21 02:08:49 +00:00
2016-01-12 01:39:24 +00:00
Contact
2015-09-21 02:08:49 +00:00
-------
2016-01-12 01:39:24 +00:00
Contact us via mailing list, email or twitter. More information is available
2016-01-12 01:43:40 +00:00
at http://www.unicorn-engine.org/contact/.
2016-01-12 01:39:24 +00:00
Contribute
----------
If you want to contribute, please pick up something from our Github issues
2016-01-12 01:43:40 +00:00
at https://github.com/unicorn-engine/unicorn.
2016-01-12 01:39:24 +00:00
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.