unicorn/README.md

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

[![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)

[![Build Status](https://travis-ci.org/unicorn-engine/unicorn.svg?branch=master)](https://travis-ci.org/unicorn-engine/unicorn)
[![Build status](https://ci.appveyor.com/api/projects/status/kojr7bald748ba2x/branch/master?svg=true)](https://ci.appveyor.com/project/aquynh/unicorn/branch/master)

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 Crystal, Clojure, Visual Basic, Perl, Rust, Ruby, Python, Java, .NET, Go, Delphi/Free Pascal and Haskell.
- 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 [docs/COMPILE.md](docs/COMPILE.md) file for how to compile and install Unicorn.

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


Contact
-------

[Contact us](http://www.unicorn-engine.org/contact/) via mailing list, email or twitter for any questions.


Contribute
----------

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

We also maintain a list of more challenged problems in a [TODO list](https://github.com/unicorn-engine/unicorn/wiki/TODO).

[CREDITS.TXT](CREDITS.TXT) records important contributors of our project.
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00			`Unicorn Engine`
			`==============`

Update README.md Change Gitter link 2016-04-05 02:09:31 +00:00			`[![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)`
Add Gitter badge 2016-04-04 16:50:11 +00:00
add Travis build status to README.md 2016-03-01 05:54:32 +00:00			`[![Build Status](https://travis-ci.org/unicorn-engine/unicorn.svg?branch=master)](https://travis-ci.org/unicorn-engine/unicorn)`
more fix for Appveyor CI 2016-03-08 05:41:24 +00:00			`[![Build status](https://ci.appveyor.com/api/projects/status/kojr7bald748ba2x/branch/master?svg=true)](https://ci.appveyor.com/project/aquynh/unicorn/branch/master)`
add Travis build status to README.md 2016-03-01 05:54:32 +00:00
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00			`Unicorn is a lightweight, multi-platform, multi-architecture CPU emulator framework`
			`based on [QEMU](http://qemu.org).`

			`Unicorn offers some unparalleled features:`

typo 2015-10-17 08:21:50 +00:00			`- Multi-architecture: ARM, ARM64 (ARMv8), M68K, MIPS, SPARC, and X86 (16, 32, 64-bit)`
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00			`- Clean/simple/lightweight/intuitive architecture-neutral API`
add Clojure 2017-12-22 16:32:33 +00:00			`- Implemented in pure C language, with bindings for Crystal, Clojure, Visual Basic, Perl, Rust, Ruby, Python, Java, .NET, Go, Delphi/Free Pascal and Haskell.`
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00			`- Native support for Windows & nix (with Mac OSX, Linux, BSD & Solaris confirmed)`
typo 2015-10-15 16:22:04 +00:00			`- High performance via Just-In-Time compilation`
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00			`- Support for fine-grained instrumentation at various levels`
			`- Thread-safety by design`
Little README change Changed 'open source' for 'free software' 2015-10-17 09:35:34 +00:00			`- Distributed under free software license GPLv2`
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00
			`Further information is available at http://www.unicorn-engine.org`


update README 2016-01-12 01:39:24 +00:00			`License`
			`-------`

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


			`Compilation & Docs`
			`------------------`
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00
docs: move COMPILE.TXT to docs/, and split it into separate files for *nix & Windows 2016-04-30 01:49:00 +00:00			`See [docs/COMPILE.md](docs/COMPILE.md) file for how to compile and install Unicorn.`
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00
rename docs/README to docs/README.md 2016-01-12 01:43:40 +00:00			`More documentation is available in [docs/README.md](docs/README.md).`
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00
update README 2016-01-12 01:39:24 +00:00
			`Contact`
change README to markdown, minor edits 2015-09-21 02:08:49 +00:00			`-------`

more readable README.md 2016-01-12 01:50:17 +00:00			`[Contact us](http://www.unicorn-engine.org/contact/) via mailing list, email or twitter for any questions.`
update README 2016-01-12 01:39:24 +00:00

			`Contribute`
			`----------`

fix link to Github issues in README.md 2016-01-12 01:53:01 +00:00			`If you want to contribute, please pick up something from our [Github issues](https://github.com/unicorn-engine/unicorn/issues).`
update README 2016-01-12 01:39:24 +00:00
more readable README.md 2016-01-12 01:50:17 +00:00			`We also maintain a list of more challenged problems in a [TODO list](https://github.com/unicorn-engine/unicorn/wiki/TODO).`
update README 2016-01-12 01:39:24 +00:00
more readable README.md 2016-01-12 01:50:17 +00:00			`[CREDITS.TXT](CREDITS.TXT) records important contributors of our project.`
update README 2016-01-12 01:39:24 +00:00