README.md (3328B)
1 AsmJit 2 ------ 3 4 AsmJit is a library for low-latency machine code generation written in C++. 5 6 * [Official Home Page (asmjit.com)](https://asmjit.com) 7 * [Official Repository (asmjit/asmjit)](https://github.com/asmjit/asmjit) 8 * [Public Chat Channel](https://app.gitter.im/#/room/#asmjit:gitter.im) 9 * [Zlib License](./LICENSE.md) 10 11 See [asmjit.com](https://asmjit.com) page for more details, examples, and documentation. 12 13 Project Organization 14 -------------------- 15 16 * **`/`** - Project root 17 * **src** - Source code 18 * **asmjit** - Source code and headers (always point include path in here) 19 * **core** - Core API, backend independent except relocations 20 * **arm** - ARM specific API, designed to be common for both AArch32 and AArch64 21 * **a64** - AArch64 specific API, used only by AArch64 backends 22 * **x86** - X86 specific API, used only by X86 and X64 backends 23 * **ujit** - Universal JIT API 24 * **testing** - Unit tests, integration tests, and benchmarks (don't embed in your project) 25 * **commons** - Common utilities shared between tests and benchmarks 26 * **bench** - Benchmarks 27 * **tests** - Unit tests and integration tests 28 * **tools** - Tools used to re-regenerate generated files (instruction DB, enum strings) 29 30 Roadmap 31 ------- 32 33 * See [Roadmap](https://asmjit.com/roadmap.html) page for more details 34 35 Contributing 36 ------------ 37 38 * See [CONTRIBUTING](./CONTRIBUTING.md) page for more details 39 40 Documentation 41 ------------- 42 43 * [Documentation Index](https://asmjit.com/doc/index.html) 44 * [Build Instructions](https://asmjit.com/doc/group__asmjit__build.html) (includes [CMake Integration](https://asmjit.com/doc/group__asmjit__build.html#cmake_integration)) 45 46 Development & Testing 47 --------------------- 48 49 * Basic configure scripts that invoke cmake are provided in project root. 50 51 Breaking Changes 52 ---------------- 53 54 Breaking the API is sometimes inevitable, what to do? 55 56 * See [Breaking Changes Guide](https://asmjit.com/doc/group__asmjit__breaking__changes.html), which is now part of AsmJit documentation 57 * See asmjit tests, they always compile and provide implementation of many use-cases: 58 * [asmjit_test_emitters.cpp](./testing/tests/asmjit_test_emitters.cpp) - Tests that demonstrate the purpose of emitters 59 * [asmjit_test_assembler_x86.cpp](./testing/tests/asmjit_test_assembler_x86.cpp) - Tests targeting AsmJit's Assembler (x86/x64) 60 * [asmjit_test_compiler_x86.cpp](./testing/tests/asmjit_test_compiler_x86.cpp) - Tests targeting AsmJit's Compiler (x86/x64) 61 * [asmjit_test_instinfo.cpp](./testing/tests/asmjit_test_instinfo.cpp) - Tests that query instruction information 62 * [asmjit_test_x86_sections.cpp](./testing/tests/asmjit_test_x86_sections.cpp) - Multiple sections test 63 * Visit our [Gitter Chat](https://app.gitter.im/#/room/#asmjit:gitter.im) if you need a quick help 64 65 Support 66 ------- 67 68 * AsmJit project has both community and commercial support, see [AsmJit's Support Page](https://asmjit.com/support.html) 69 * Organizations that rely on AsmJit should support the development! 70 71 Notable Donors List: 72 73 * [ZehMatt](https://github.com/ZehMatt) 74 75 Authors & Maintainers 76 --------------------- 77 78 * Petr Kobalicek <kobalicek.petr@gmail.com> ([website](https://kobalicek.com))