summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/asmjit/README.md
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/asmjit/README.md')
-rw-r--r--3rdparty/asmjit/README.md52
1 files changed, 31 insertions, 21 deletions
diff --git a/3rdparty/asmjit/README.md b/3rdparty/asmjit/README.md
index abe51bb2169..ee0c7200ed3 100644
--- a/3rdparty/asmjit/README.md
+++ b/3rdparty/asmjit/README.md
@@ -5,7 +5,7 @@ AsmJit is a lightweight library for machine code generation written in C++ langu
* [Official Home Page (asmjit.com)](https://asmjit.com)
* [Official Repository (asmjit/asmjit)](https://github.com/asmjit/asmjit)
- * [Public Chat Channel](https://gitter.im/asmjit/asmjit)
+ * [Public Chat Channel](https://app.gitter.im/#/room/#asmjit:gitter.im)
* [Zlib License](./LICENSE.md)
See [asmjit.com](https://asmjit.com) page for more details, examples, and documentation.
@@ -16,40 +16,50 @@ Documentation
* [Documentation Index](https://asmjit.com/doc/index.html)
* [Build Instructions](https://asmjit.com/doc/group__asmjit__build.html)
+Contributing
+------------
+
+ * See [CONTRIBUTING](./CONTRIBUTING.md) page for more details
+
Breaking Changes
----------------
Breaking the API is sometimes inevitable, what to do?
- * See [Breaking Changes Guide](https://asmjit.com/doc/group__asmjit__breaking__changes.html), which is now part of AsmJit documentation.
+ * See [Breaking Changes Guide](https://asmjit.com/doc/group__asmjit__breaking__changes.html), which is now part of AsmJit documentation
* See asmjit tests, they always compile and provide implementation of many use-cases:
- * [asmjit_test_x86_asm.cpp](./test/asmjit_test_x86_asm.cpp) - Tests that demonstrate the purpose of emitters.
- * [asmjit_test_x86_cc.cpp](./test/asmjit_test_x86_cc.cpp) - A lot of tests targeting Compiler infrastructure.
+ * [asmjit_test_emitters.cpp](./test/asmjit_test_emitters.cpp) - Tests that demonstrate the purpose of emitters
+ * [asmjit_test_assembler_x86.cpp](./test/asmjit_test_assembler_x86.cpp) - Tests targeting AsmJit's Assembler (x86/x64)
+ * [asmjit_test_compiler_x86.cpp](./test/asmjit_test_compiler_x86.cpp) - Tests targeting AsmJit's Compiler (x86/x64)
+ * [asmjit_test_instinfo.cpp](./test/asmjit_test_instinfo.cpp) - Tests that query instruction information
* [asmjit_test_x86_sections.cpp](./test/asmjit_test_x86_sections.cpp) - Multiple sections test.
- * Visit our [Official Chat](https://gitter.im/asmjit/asmjit) if you need a quick help.
+ * Visit our [Gitter Chat](https://app.gitter.im/#/room/#asmjit:gitter.im) if you need a quick help
Project Organization
--------------------
- * **`/`** - Project root.
- * **src** - Source code.
- * **asmjit** - Source code and headers (always point include path in here).
- * **core** - Core API, backend independent except relocations.
- * **arm** - ARM specific API, used only by ARM and AArch64 backends.
- * **x86** - X86 specific API, used only by X86 and X64 backends.
- * **test** - Unit and integration tests (don't embed in your project).
- * **tools** - Tools used for configuring, documenting, and generating files.
+ * **`/`** - Project root
+ * **src** - Source code
+ * **asmjit** - Source code and headers (always point include path in here)
+ * **core** - Core API, backend independent except relocations
+ * **arm** - ARM specific API, used only by ARM and AArch64 backends
+ * **x86** - X86 specific API, used only by X86 and X64 backends
+ * **test** - Unit and integration tests (don't embed in your project)
+ * **tools** - Tools used for configuring, documenting, and generating files
-TODO
-----
+Ports
+-----
- * [ ] Core:
- * [ ] Add support for user external buffers in CodeHolder.
- * [ ] Ports:
- * [ ] ARM/Thumb/AArch64 support.
+ * [ ] 32-bit ARM/Thumb port (work in progress)
+ * [ ] RISC-V port (not in progress, help welcome)
-Donors
-------
+Support
+-------
+
+ * AsmJit project has both community and commercial support, see [AsmJit's Support Page](https://asmjit.com/support.html)
+ * You can help the development and maintenance through Petr Kobalicek's [GitHub sponsors Profile](https://github.com/sponsors/kobalicek)
+
+Notable Donors List:
* [ZehMatt](https://github.com/ZehMatt)