From a5ba633fe46ec2415d3ec9ba7776da78888526d0 Mon Sep 17 00:00:00 2001
From: Tang <jing.tang@verisilicon.com>
Date: Wed, 3 Aug 2022 15:30:38 +0800
Subject: [PATCH] add readme for ovxlib_bin_build.sh

---
 src/tim/vx/internal/ovxlib_bin_build.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 src/tim/vx/internal/ovxlib_bin_build.md

diff --git a/src/tim/vx/internal/ovxlib_bin_build.md b/src/tim/vx/internal/ovxlib_bin_build.md
new file mode 100644
index 0000000..427d09b
--- /dev/null
+++ b/src/tim/vx/internal/ovxlib_bin_build.md
@@ -0,0 +1,16 @@
+# How to prebuild VXC binary file for shader scripts in ovxlib?
+
+Generally shader scripts will be compiled into VXC binary file on app run time. But this compilation will cost a lot of time. If we prebuild VXC binary file, this time will be saved.
+
+## prepare
+
+Full driver source is needed. You MUST build driver firstly, and make sure `vcCompiler` is build properly.
+
+## build
+
+```
+cd tim/vx/internal/
+./ovxlib_bin_build.sh <VIVANTE SDK path> <vcCompiler path> <ovxlib path(for example: src/tim/vx/internal/)> <config file path(for example: viv_vip8000nanosi+_pid0x9F.config)>
+```
+
+After build, you will find many `.h` files in `<ovxlib path>/include/libnnext/vx_bin`. These `.h` files will be compiled into libtim-vx.so when build TIM-VX.