about summary refs log tree commit diff stats
path: root/wrapperhelper
diff options
context:
space:
mode:
Diffstat (limited to 'wrapperhelper')
-rw-r--r--wrapperhelper/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/wrapperhelper/README.md b/wrapperhelper/README.md
index cedce959..1edd4db1 100644
--- a/wrapperhelper/README.md
+++ b/wrapperhelper/README.md
@@ -1,5 +1,8 @@
 # Wrapper helper
 
+**WARNING: There are still many problems with this tool. Please do NOT submit code generated directly by the tool, you should only use it as a preliminary reference.**
+
+
 This tool is based on libclangtooling.
 
 It parses the AST of the library header files, generating the required structures of the wrapping library, including:
@@ -10,6 +13,15 @@ etc. Of course, this cannot completely automate everything, it can only be used
 
 At the same time, this tool is also quite rough, and may even have errors.
 
+## Build
+
+```
+sudo apt install libclang-14-dev
+cd wrapperhelper
+mkdir build; cd build; cmake ..
+make
+```
+
 ## Usage:
 
     helper <filename> <libname> [guest_triple] [host_triple] -- <clang_flags>