unicorn/README.md

53 lines
1.8 KiB
Markdown
Raw Normal View History

2015-09-21 04:08:49 +02:00
Unicorn Engine
==============
2016-03-01 06:54:32 +01:00
[![Build Status](https://travis-ci.org/unicorn-engine/unicorn.svg?branch=master)](https://travis-ci.org/unicorn-engine/unicorn)
2016-03-08 06:41:24 +01:00
[![Build status](https://ci.appveyor.com/api/projects/status/kojr7bald748ba2x/branch/master?svg=true)](https://ci.appveyor.com/project/aquynh/unicorn/branch/master)
2016-03-01 06:54:32 +01:00
2015-09-21 04:08:49 +02:00
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 10:21:50 +02:00
- Multi-architecture: ARM, ARM64 (ARMv8), M68K, MIPS, SPARC, and X86 (16, 32, 64-bit)
2015-09-21 04:08:49 +02:00
- Clean/simple/lightweight/intuitive architecture-neutral API
2016-03-22 13:58:06 +01:00
- Implemented in pure C language, with bindings for Ruby, Python, Java, MSVC, .NET, Go and Delphi/Free Pascal.
2015-09-21 04:08:49 +02:00
- Native support for Windows & *nix (with Mac OSX, Linux, *BSD & Solaris confirmed)
2015-10-15 18:22:04 +02:00
- High performance via Just-In-Time compilation
2015-09-21 04:08:49 +02:00
- Support for fine-grained instrumentation at various levels
- Thread-safety by design
- Distributed under free software license GPLv2
2015-09-21 04:08:49 +02:00
Further information is available at http://www.unicorn-engine.org
2016-01-12 02:39:24 +01:00
License
-------
This project is released under the [GPL license](COPYING).
Compilation & Docs
------------------
2015-09-21 04:08:49 +02:00
See [COMPILE.TXT](COMPILE.TXT) file for how to compile and install Unicorn.
2016-01-12 02:43:40 +01:00
More documentation is available in [docs/README.md](docs/README.md).
2015-09-21 04:08:49 +02:00
2016-01-12 02:39:24 +01:00
Contact
2015-09-21 04:08:49 +02:00
-------
2016-01-12 02:50:17 +01:00
[Contact us](http://www.unicorn-engine.org/contact/) via mailing list, email or twitter for any questions.
2016-01-12 02:39:24 +01:00
Contribute
----------
2016-01-12 02:53:01 +01:00
If you want to contribute, please pick up something from our [Github issues](https://github.com/unicorn-engine/unicorn/issues).
2016-01-12 02:39:24 +01:00
2016-01-12 02:50:17 +01:00
We also maintain a list of more challenged problems in a [TODO list](https://github.com/unicorn-engine/unicorn/wiki/TODO).
2016-01-12 02:39:24 +01:00
2016-01-12 02:50:17 +01:00
[CREDITS.TXT](CREDITS.TXT) records important contributors of our project.
2016-01-12 02:39:24 +01:00